Skip to content

docs: add docs for docker deployment #111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: add docs for docker deployment #111

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e539278
docs: add docs for docker deployment
xuhe2 Aug 7, 2024
f5db23f
fix: capitalize the title; feat: add options usage for docker and cha…
xuhe2 Aug 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,6 @@ WORKDIR /

COPY --from=builder /go/bin/spoof-dpi .

EXPOSE 8080

ENTRYPOINT ["./spoof-dpi"]
7 changes: 7 additions & 0 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,13 @@ $ cd SpoofDPI
$ go build ./cmd/...
```

## docker
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please capitalize the title

You can use Dockerfile to build a docker image
```shell
docker build ./ -t spoof-dpi:latest
```
Use `docker run -it -p 8080:8080 --name spoof-dpi spoof-dpi:latest` to run container
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think we should show some other example that passes options through the docker run command like below

$ docker run -it -p 8080:8080 spoof-dpi:latest --enable-doh

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@xvzc Better also add --name "..." and --rm to avoid generating a lot of garbage after each restart.
https://docs.docker.com/reference/cli/docker/container/run/#rm


# Usage
```
Usage: spoof-dpi [options...]
Expand Down