-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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.
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
add information about docker-compose.yml to README.md #4243
base: main
Are you sure you want to change the base?
Conversation
add the yaml block with the simple docker compose set up with the pinned docker image. add the link to the wiki page "Using Docker Compose".
|
||
the left side of `volumes:` is where you can find vaultwarden data on your PC/server relative to the folder where you store the docker-compose.yml file | ||
example: | ||
```yaml |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not yaml
. Could maybe use text
instead?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adding context (response to the comment that was removed). Just line 62 using yaml
does not seem correct to me as the contents of the code fence is a directory structure example, not actual yaml. The yaml above for the compose is accurately using yaml
for its code fence.
- 80:80 | ||
restart: unless-stopped | ||
``` | ||
and `docker compose up` or `docker compose up -d` to pull and run conteiner. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix spelling of container instead of conteiner
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The previous PR had several comments, which do not seem to be addressed here.
Please make sure it is up-to-date with the comments there.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure if the README is the best place for a docker-compose.yml
example. Overall I think that the whole sections needs to be rewritten.
services: | ||
vaultwarden: | ||
container_name: vaultwarden | ||
image: vaultwarden/server:1.30.0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
image: vaultwarden/server:1.30.0 | |
image: vaultwarden/server:latest |
<vaultwarden data from the /data folder inside the container> | ||
``` | ||
|
||
the left side of `ports:` is the port your instance will run on (example: `http://127.0.0.1:80`) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Your example is a bit confusing because by default 80:80
will bind to 0.0.0.0
(meaning all network interfaces) and not 127.0.0.1
which might be important (because to achieve that you have to be specific, i.e. 127.0.0.1:80:80
). However, I don't think that our README is the right place for explaining the intricacies of networking in compose.
volumes: | ||
- ./vw-data/:/data/ | ||
ports: | ||
- 80:80 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- 80:80 | |
- "80:80" |
Docker's recommendation is "always explicitly specifying your port mappings as strings".
``` | ||
and `docker compose up` or `docker compose up -d` to pull and run conteiner. | ||
|
||
the left side of `volumes:` is where you can find vaultwarden data on your PC/server relative to the folder where you store the docker-compose.yml file |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Instead of this explanation I think it's better to link to https://docs.docker.com/storage/ (which I would do above in a general section about persistent storage because most of it would also apply to the docker run
example) and just refer to the wiki for further information.
@@ -35,13 +35,41 @@ Basically full implementation of Bitwarden API is provided including: | |||
|
|||
## Installation | |||
Pull the docker image and mount a volume from the host for persistent storage: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that you need to rewrite the Installation section as it's currently interrupted by the added subsections, especially because the existing documentation only perfunctorily explains the docker commands.
I actually think we should create a better Wiki page on how to use it, and link that in the Readme. That would only clutter the whole Readme while that is better suited for a good written Wiki page. I'm leaning to closing this PR because of this. If you can create a good wiki article, or update an existing one and link to it in this PR then that is also fine :). |
just for the record: i updated the wiki a bit and made a subchapter for a minimal docker compose configuration https://github.com/dani-garcia/vaultwarden/wiki/Using-Docker-Compose#minimal-template-for-no-reverse-proxy--a-reverse-proxy-configured-by-yourself-caddy-example-below I wonder if the caddy examples are really necessary, since there is a wonderful wiki for reverse proxy |
because of the cleaning of this branch, github closed previous pull request, sorry