Change the image name

Miro Prasil 2019-05-16 15:01:12 +01:00
parent 2db0ead5fe
commit 492aea369a
22 changed files with 46 additions and 46 deletions

@ -7,7 +7,7 @@ docker run -d --name bitwarden \
-e DATA_FOLDER=/persistent \ -e DATA_FOLDER=/persistent \
-v /bw-data/:/persistent/ \ -v /bw-data/:/persistent/ \
-p 80:80 \ -p 80:80 \
mprasil/bitwarden:latest bitwardenrs/server:latest
``` ```
Notice, that you need to adapt your volume mount accordingly. Notice, that you need to adapt your volume mount accordingly.
@ -22,7 +22,7 @@ docker run -d --name bitwarden \
-v /bw-data/:/data/ \ -v /bw-data/:/data/ \
-v /bw-database/:/database/ \ -v /bw-database/:/database/ \
-p 80:80 \ -p 80:80 \
mprasil/bitwarden:latest bitwardenrs/server:latest
``` ```
Note, that you need to remember to mount the volume for both database and other persistent data if they are different. Note, that you need to remember to mount the volume for both database and other persistent data if they are different.
@ -37,7 +37,7 @@ docker run -d --name bitwarden \
-v /bw-data/:/data/ \ -v /bw-data/:/data/ \
-v /bw-attachments/:/attachments/ \ -v /bw-attachments/:/attachments/ \
-p 80:80 \ -p 80:80 \
mprasil/bitwarden:latest bitwardenrs/server:latest
``` ```
Note, that you need to remember to mount the volume for both attachments and other persistent data if they are different. Note, that you need to remember to mount the volume for both attachments and other persistent data if they are different.
@ -52,7 +52,7 @@ docker run -d --name bitwarden \
-v /bw-data/:/data/ \ -v /bw-data/:/data/ \
-v /icon_cache/ \ -v /icon_cache/ \
-p 80:80 \ -p 80:80 \
mprasil/bitwarden:latest bitwardenrs/server:latest
``` ```
Note, that in the above example we don't mount the volume locally, which means it won't be persisted during the upgrade unless you use intermediate data container using `--volumes-from`. This will impact performance as bitwarden will have to re-download the icons on restart, but might save you from having stale icons in cache as they are not automatically cleaned. Note, that in the above example we don't mount the volume locally, which means it won't be persisted during the upgrade unless you use intermediate data container using `--volumes-from`. This will impact performance as bitwarden will have to re-download the icons on restart, but might save you from having stale icons in cache as they are not automatically cleaned.

@ -7,5 +7,5 @@ docker run -d --name bitwarden \
-e ROCKET_LIMITS={json=10485760} \ -e ROCKET_LIMITS={json=10485760} \
-v /bw-data/:/data/ \ -v /bw-data/:/data/ \
-p 80:80 \ -p 80:80 \
mprasil/bitwarden:latest bitwardenrs/server:latest
``` ```

@ -7,5 +7,5 @@ docker run -d --name bitwarden \
-e ROCKET_WORKERS=20 \ -e ROCKET_WORKERS=20 \
-v /bw-data/:/data/ \ -v /bw-data/:/data/ \
-p 80:80 \ -p 80:80 \
mprasil/bitwarden:latest bitwardenrs/server:latest
``` ```

@ -7,5 +7,5 @@ docker run -d --name bitwarden \
-e DISABLE_ADMIN_TOKEN=true \ -e DISABLE_ADMIN_TOKEN=true \
-v /bw-data/:/data/ \ -v /bw-data/:/data/ \
-p 80:80 \ -p 80:80 \
mprasil/bitwarden:latest bitwardenrs/server:latest
``` ```

@ -6,5 +6,5 @@ docker run -d --name bitwarden \
-e INVITATIONS_ALLOWED=false \ -e INVITATIONS_ALLOWED=false \
-v /bw-data/:/data/ \ -v /bw-data/:/data/ \
-p 80:80 \ -p 80:80 \
mprasil/bitwarden:latest bitwardenrs/server:latest
``` ```

@ -5,6 +5,6 @@ docker run -d --name bitwarden \
-e SIGNUPS_ALLOWED=false \ -e SIGNUPS_ALLOWED=false \
-v /bw-data/:/data/ \ -v /bw-data/:/data/ \
-p 80:80 \ -p 80:80 \
mprasil/bitwarden:latest bitwardenrs/server:latest
``` ```
Note: While users can't register on their own, they can still be invited by already registered users. See [[Disable invitations|disable-invitations]] if you also want to disable that. Note: While users can't register on their own, they can still be invited by already registered users. See [[Disable invitations|disable-invitations]] if you also want to disable that.

@ -5,7 +5,7 @@ docker run -d --name bitwarden \
-e WEB_VAULT_ENABLED=false \ -e WEB_VAULT_ENABLED=false \
-v /bw-data/:/data/ \ -v /bw-data/:/data/ \
-p 80:80 \ -p 80:80 \
mprasil/bitwarden:latest bitwardenrs/server:latest
``` ```
Alternatively you can override the Vault files and provide your own static files to host. You can do that by mounting a path with your files over the `/web-vault` directory in the container. Just make sure the directory contains at least `index.html` file. Alternatively you can override the Vault files and provide your own static files to host. You can do that by mounting a path with your files over the `/web-vault` directory in the container. Just make sure the directory contains at least `index.html` file.
@ -14,7 +14,7 @@ docker run -d --name bitwarden \
-v /path/to/static/files_directory:/web-vault \ -v /path/to/static/files_directory:/web-vault \
-v /bw-data/:/data/ \ -v /bw-data/:/data/ \
-p 80:80 \ -p 80:80 \
mprasil/bitwarden:latest bitwardenrs/server:latest
``` ```
Note that you can also change the path where bitwarden_rs looks for static files by providing the `WEB_VAULT_FOLDER` environment variable with the path. Note that you can also change the path where bitwarden_rs looks for static files by providing the `WEB_VAULT_FOLDER` environment variable with the path.

@ -14,7 +14,7 @@ docker run -d --name bitwarden \
-v /ssl/keys/:/ssl/ \ -v /ssl/keys/:/ssl/ \
-v /bw-data/:/data/ \ -v /bw-data/:/data/ \
-p 443:80 \ -p 443:80 \
mprasil/bitwarden:latest bitwardenrs/server:latest
``` ```
Note that you need to mount ssl files and you need to forward appropriate port. Note that you need to mount ssl files and you need to forward appropriate port.
@ -34,5 +34,5 @@ docker run -d --name bitwarden \
-v /etc/letsencrypt/:/ssl/ \ -v /etc/letsencrypt/:/ssl/ \
-v /bw-data/:/data/ \ -v /bw-data/:/data/ \
-p 443:80 \ -p 443:80 \
mprasil/bitwarden:latest bitwardenrs/server:latest
``` ```

@ -8,7 +8,7 @@ docker run -d --name bitwarden \
-e DOMAIN=https://bw.domain.tld \ -e DOMAIN=https://bw.domain.tld \
-v /bw-data/:/data/ \ -v /bw-data/:/data/ \
-p 80:80 \ -p 80:80 \
mprasil/bitwarden:latest bitwardenrs/server:latest
``` ```
Note that the value has to include the `https://` and it may include a port at the end (in the format of `https://bw.domain.tld:port`) when not using `443`. Note that the value has to include the `https://` and it may include a port at the end (in the format of `https://bw.domain.tld:port`) when not using `443`.

@ -15,7 +15,7 @@ docker run -d --name bitwarden \
-v /bw-data/:/data/ \ -v /bw-data/:/data/ \
-p 80:80 \ -p 80:80 \
-p 3012:3012 \ -p 3012:3012 \
mprasil/bitwarden:latest bitwardenrs/server:latest
``` ```
Note: The reason for this workaround is the lack of support for WebSockets from Rocket (though [it's a planned feature](https://github.com/SergioBenitez/Rocket/issues/90)), which forces us to launch a secondary server on a separate port. Note: The reason for this workaround is the lack of support for WebSockets from Rocket (though [it's a planned feature](https://github.com/SergioBenitez/Rocket/issues/90)), which forces us to launch a secondary server on a separate port.

@ -12,5 +12,5 @@ docker run -d --name bitwarden \
-e YUBICO_SECRET_KEY=ABCDEABCDEABCDEABCDE= \ -e YUBICO_SECRET_KEY=ABCDEABCDEABCDEABCDE= \
-v /bw-data/:/data/ \ -v /bw-data/:/data/ \
-p 80:80 \ -p 80:80 \
mprasil/bitwarden:latest bitwardenrs/server:latest
``` ```

@ -11,7 +11,7 @@ docker run -d --name bitwarden \
-e ADMIN_TOKEN=some_random_token_as_per_above_explanation \ -e ADMIN_TOKEN=some_random_token_as_per_above_explanation \
-v /bw-data/:/data/ \ -v /bw-data/:/data/ \
-p 80:80 \ -p 80:80 \
mprasil/bitwarden:latest bitwardenrs/server:latest
``` ```
After this, the page will be available in the `/admin` subdomain. After this, the page will be available in the `/admin` subdomain.

@ -5,5 +5,5 @@ docker run -d --name bitwarden \
-e SHOW_PASSWORD_HINT=false \ -e SHOW_PASSWORD_HINT=false \
-v /bw-data/:/data/ \ -v /bw-data/:/data/ \
-p 80:80 \ -p 80:80 \
mprasil/bitwarden:latest bitwardenrs/server:latest
``` ```

@ -1,4 +1,4 @@
By default `mprasil/bitwarden` is using root user to run service inside the container. There are few things you need to set to run the container as non-root user if you wish to do so: By default `bitwardenrs/server` is using root user to run service inside the container. There are few things you need to set to run the container as non-root user if you wish to do so:
1. Make sure that the directory, you're mounting inside the container will be writable by the user. For example if you decide to run as `nobody`, the directory needs to be writable by user with id 65534. For other ways to specify user inside the container, see the [docker documentation](https://docs.docker.com/engine/reference/run/#user), in our examples here we will use `nobody`. 1. Make sure that the directory, you're mounting inside the container will be writable by the user. For example if you decide to run as `nobody`, the directory needs to be writable by user with id 65534. For other ways to specify user inside the container, see the [docker documentation](https://docs.docker.com/engine/reference/run/#user), in our examples here we will use `nobody`.
@ -23,7 +23,7 @@ docker run -d \
-e ROCKET_PORT=1024 \ -e ROCKET_PORT=1024 \
-v /bw-data/:/data/ \ -v /bw-data/:/data/ \
-p 80:1024 \ -p 80:1024 \
mprasil/bitwarden:latest bitwardenrs/server:latest
``` ```
Notice that the port mapping (`-p 80:1024`) reflects the `ROCKET_PORT` setting. Notice that the port mapping (`-p 80:1024`) reflects the `ROCKET_PORT` setting.

@ -12,4 +12,4 @@ docker run -d --name bitwarden \
-e ROCKET_PORT=8080 \ -e ROCKET_PORT=8080 \
-v /bw-data/:/data/ \ -v /bw-data/:/data/ \
-p 80:8080 \ -p 80:8080 \
mprasil/bitwarden:latest bitwardenrs/server:latest

@ -15,12 +15,12 @@ Requires=docker.service
[Service] [Service]
TimeoutStartSec=0 TimeoutStartSec=0
ExecStartPre=/usr/bin/docker pull mprasil/bitwarden:latest ExecStartPre=/usr/bin/docker pull bitwardenrs/server:latest
ExecStart=/usr/bin/systemd-docker --cgroups name=systemd --env run \ ExecStart=/usr/bin/systemd-docker --cgroups name=systemd --env run \
-p 8080:80 \ -p 8080:80 \
-p 8081:3012 \ -p 8081:3012 \
-v /opt/bw-data:/data/ \ -v /opt/bw-data:/data/ \
--rm --name %n mprasil/bitwarden:latest --rm --name %n bitwardenrs/server:latest
Restart=always Restart=always
RestartSec=10s RestartSec=10s
Type=notify Type=notify

@ -41,7 +41,7 @@ docker run -d --name bitwarden \
-e ENABLE_DB_WAL=false \ -e ENABLE_DB_WAL=false \
-v /bw-data/:/data/ \ -v /bw-data/:/data/ \
-p 80:80 \ -p 80:80 \
mprasil/bitwarden:latest bitwardenrs/server:latest
``` ```
Make sure to always start with this variable present as starting even once without it will enable WAL again. (if that happens start at the [first step](#1-disable-wal-on-old-db) to disable it again) Make sure to always start with this variable present as starting even once without it will enable WAL again. (if that happens start at the [first step](#1-disable-wal-on-old-db) to disable it again)

@ -10,7 +10,7 @@ docker run -d --name bitwarden \
-e SMTP_PASSWORD=<password> \ -e SMTP_PASSWORD=<password> \
-v /bw-data/:/data/ \ -v /bw-data/:/data/ \
-p 80:80 \ -p 80:80 \
mprasil/bitwarden:latest bitwardenrs/server:latest
``` ```
When `SMTP_SSL` is set to `true`(this is the default), only TLSv1.1 and TLSv1.2 protocols will be accepted and `SMTP_PORT` will default to `587`. If set to `false`, `SMTP_PORT` will default to `25` and the connection won't be encrypted. This can be very insecure, use this setting only if you know what you're doing. When `SMTP_SSL` is set to `true`(this is the default), only TLSv1.1 and TLSv1.2 protocols will be accepted and `SMTP_PORT` will default to `587`. If set to `false`, `SMTP_PORT` will default to `25` and the connection won't be encrypted. This can be very insecure, use this setting only if you know what you're doing.

@ -1,7 +1,7 @@
The persistent data is stored under /data inside the container, so the only requirement for persistent deployment using Docker is to mount persistent volume at the path: The persistent data is stored under /data inside the container, so the only requirement for persistent deployment using Docker is to mount persistent volume at the path:
``` ```
docker run -d --name bitwarden -v /bw-data/:/data/ -p 80:80 mprasil/bitwarden:latest docker run -d --name bitwarden -v /bw-data/:/data/ -p 80:80 bitwardenrs/server:latest
``` ```
This will preserve any persistent data under `/bw-data/`, you can adapt the path to whatever suits you. This will preserve any persistent data under `/bw-data/`, you can adapt the path to whatever suits you.

@ -2,14 +2,14 @@ Updating is straightforward, you just make sure to preserve the mounted volume.
```sh ```sh
# Pull the latest version # Pull the latest version
docker pull mprasil/bitwarden:latest docker pull bitwardenrs/server:latest
# Stop and remove the old container # Stop and remove the old container
docker stop bitwarden docker stop bitwarden
docker rm bitwarden docker rm bitwarden
# Start new container with the data mounted # Start new container with the data mounted
docker run -d --name bitwarden -v /bw-data/:/data/ -p 80:80 mprasil/bitwarden:latest docker run -d --name bitwarden -v /bw-data/:/data/ -p 80:80 bitwardenrs/server:latest
``` ```
Then visit [http://localhost:80](http://localhost:80) Then visit [http://localhost:80](http://localhost:80)
@ -17,7 +17,7 @@ In case you didn't bind mount the volume for persistent data, you need an interm
```sh ```sh
# Pull the latest version # Pull the latest version
docker pull mprasil/bitwarden:latest docker pull bitwardenrs/server:latest
# Create intermediate container to preserve data # Create intermediate container to preserve data
docker run --volumes-from bitwarden --name bitwarden_data busybox true docker run --volumes-from bitwarden --name bitwarden_data busybox true
@ -27,7 +27,7 @@ docker stop bitwarden
docker rm bitwarden docker rm bitwarden
# Start new container with the data mounted # Start new container with the data mounted
docker run -d --volumes-from bitwarden_data --name bitwarden -p 80:80 mprasil/bitwarden:latest docker run -d --volumes-from bitwarden_data --name bitwarden -p 80:80 bitwardenrs/server:latest
# Optionally remove the intermediate container # Optionally remove the intermediate container
docker rm bitwarden_data docker rm bitwarden_data

@ -10,7 +10,7 @@ version: "3"
services: services:
bitwarden: bitwarden:
image: mprasil/bitwarden image: bitwardenrs/server
restart: always restart: always
volumes: volumes:
- ./bw-data:/data - ./bw-data:/data
@ -79,13 +79,13 @@ docker-compose down
``` ```
stops and destroys the containers. stops and destroys the containers.
If there's no need for websocket notifications, you can run Bitwarden_rs alone. Here's my example. Actually I'm running Bitwarden_rs on my Raspberry Pi and I'm using mprasil/bitwarden:raspberry image. If you want to do the same, remember to change it to the example. If there's no need for websocket notifications, you can run Bitwarden_rs alone. Here's my example. Actually I'm running Bitwarden_rs on my Raspberry Pi and I'm using bitwardenrs/server:raspberry image. If you want to do the same, remember to change it to the example.
``` ```
#docker-compose.yml #docker-compose.yml
version: '3' version: '3'
services: services:
bitwarden: bitwarden:
image: mprasil/bitwarden image: bitwardenrs/server
restart: always restart: always
volumes: volumes:
- ./bw-data/:/data/ - ./bw-data/:/data/

@ -1,4 +1,4 @@
If you plan to use docker to run `bitwarden_rs`, you'll notice there are several image versions available. In most common case, you're going to run this service on amd64 (x86) hardware and you want to use the latest code. In this case `mprasil/bitwarden` is the image to use. If you plan to use docker to run `bitwarden_rs`, you'll notice there are several image versions available. In most common case, you're going to run this service on amd64 (x86) hardware and you want to use the latest code. In this case `bitwardenrs/server` is the image to use.
Some users might want to use `bitwarden_rs` on different HW or they rather run a specific version of the service. In this case there are multiple options. Some users might want to use `bitwarden_rs` on different HW or they rather run a specific version of the service. In this case there are multiple options.
@ -8,33 +8,33 @@ The most common architecture is amd64 - your PC or server probably uses this one
Based on your architecture, you can use one of the following images: Based on your architecture, you can use one of the following images:
### `mprasil/bitwarden:latest` ### `bitwardenrs/server:latest`
The "default image", runs on amd64. (x86, 64bit) The "default image", runs on amd64. (x86, 64bit)
### `mprasil/bitwarden:alpine` ### `bitwardenrs/server:alpine`
Alpine-based amd64 image, same as above but a little bit smaller Alpine-based amd64 image, same as above but a little bit smaller
### `mprasil/bitwarden:raspberry` ### `bitwardenrs/server:raspberry`
Armv7hf image that should run on Raspberry Pi 2 or newer and possibly on any other compatible boards. This image won't run on Raspberry Pi 1 or Raspberry Pi Zero as those use armv6 CPU. Armv7hf image that should run on Raspberry Pi 2 or newer and possibly on any other compatible boards. This image won't run on Raspberry Pi 1 or Raspberry Pi Zero as those use armv6 CPU.
### `mprasil/bitwarden:armv6` ### `bitwardenrs/server:armv6`
Armv6 image for Raspberry Pi 1 and Raspberry Pi Zero. Armv6 image for Raspberry Pi 1 and Raspberry Pi Zero.
### `mprasil/bitwarden:aarch64` ### `bitwardenrs/server:aarch64`
Aarch64 image, that should run on ARMv8 devices like Raspberry Pi 3 or possibly other ARMv8 based devices. Aarch64 image, that should run on ARMv8 devices like Raspberry Pi 3 or possibly other ARMv8 based devices.
**Note** that this will also require aarch64 distribution installed on your device, so for example if you use Raspbian on your Raspberry Pi 3, you still need to use `mprasil/bitwarden:raspberry` as Raspbian is armv7hf distribution. **Note** that this will also require aarch64 distribution installed on your device, so for example if you use Raspbian on your Raspberry Pi 3, you still need to use `bitwardenrs/server:raspberry` as Raspbian is armv7hf distribution.
## Running a specific version ## Running a specific version
Normally it should be okay to use the latest version of the image as we aim to provide stable images there. However if you prefer to run a specific version of the service and update to the next version on your own pace, we do have versioned releases available. Normally it should be okay to use the latest version of the image as we aim to provide stable images there. However if you prefer to run a specific version of the service and update to the next version on your own pace, we do have versioned releases available.
You can run specific version by running image tagged with version number - for example `mprasil/bitwarden:1.7.0`. If you run your service on different architecture (see above) you can use version provided for your architecture - like `mprasil/bitwarden:1.7.0-raspberry` You can run specific version by running image tagged with version number - for example `bitwardenrs/server:1.7.0`. If you run your service on different architecture (see above) you can use version provided for your architecture - like `bitwardenrs/server:1.7.0-raspberry`
**Note** that we have no control over releases of the client applications and they often expect to have the latest API supported, so running older versions of `bitwarden_rs` might lead to client app misbehaving. (e.g. missing or broken functionality) The Vault being an exception as it is bundled with the image and thus the version shipped there is going to be updated together with the service. This is why we usually recommend running the latest image as it should generally be the most compatible version with the updated upstream apps. **Note** that we have no control over releases of the client applications and they often expect to have the latest API supported, so running older versions of `bitwarden_rs` might lead to client app misbehaving. (e.g. missing or broken functionality) The Vault being an exception as it is bundled with the image and thus the version shipped there is going to be updated together with the service. This is why we usually recommend running the latest image as it should generally be the most compatible version with the updated upstream apps.
@ -44,8 +44,8 @@ Please add your details here, if you're running the image on a hardware that is
| Hardware used | OS | Docker architecture reported | Image used | Status | Notes | | Hardware used | OS | Docker architecture reported | Image used | Status | Notes |
|----------------------|--------------|------------------------------|---------------------|--------|-------| |----------------------|--------------|------------------------------|---------------------|--------|-------|
| Regular 64bit server | Ubuntu 18.04 | x86_64 | `mprasil/bitwarden` | OK | | | Regular 64bit server | Ubuntu 18.04 | x86_64 | `bitwardenrs/server` | OK | |
| O-Droid HC2 | Armbian | arm7l (arm32) | `registry.lollipopcloud.solutions/arm32v7/bitwarden` (see notes) | OK | Unofficial image built from upstream sources ; `mprasil/bitwarden:raspberry` is the official equivalent image | | O-Droid HC2 | Armbian | arm7l (arm32) | `registry.lollipopcloud.solutions/arm32v7/bitwarden` (see notes) | OK | Unofficial image built from upstream sources ; `bitwardenrs/server:raspberry` is the official equivalent image |
| Raspberry Pi Zero W | Raspbian (4.14.98+) | linux/arm (armv6l) | `mprasil/bitwarden:armv6` | OK | | | Raspberry Pi Zero W | Raspbian (4.14.98+) | linux/arm (armv6l) | `bitwardenrs/server:armv6` | OK | |
| Raspberry Pi 3 B | Raspbian (4.14.98-v7+) | linux/arm (armv7l) | `mprasil/bitwarden:raspberry` | OK | | | Raspberry Pi 3 B | Raspbian (4.14.98-v7+) | linux/arm (armv7l) | `bitwardenrs/server:raspberry` | OK | |
| Synology | DSM (DSM 6.2.1-23824 Update 6) | Docker-x64-17.05.0-0367 | `mprasil/bitwarden:latest` | OK | | | Synology | DSM (DSM 6.2.1-23824 Update 6) | Docker-x64-17.05.0-0367 | `bitwardenrs/server:latest` | OK | |