add information about docker-compose.yml to README.md #4243
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.
This is not yaml. Could maybe use text instead?
There was a problem hiding this comment.
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.
Fix spelling of container instead of conteiner
| services: | ||
| vaultwarden: | ||
| container_name: vaultwarden | ||
| image: vaultwarden/server:1.30.0 |
There was a problem hiding this comment.
| 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.
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.
| - 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.
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.
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 :). |
because of the cleaning of this branch, github closed previous pull request, sorry