sosandroid / docker-bitwarden_rs-caddy-synology

Docker compose for Bitwarden_rs with Caddy on Synology

Docker Vaultwarden proxified for Synology NAS

A docker-compose ready package to run Vaultwarden proxified with Caddy server. This setup provides a Vaultwarden server with support of websocket notifications.

The goal is to keep the Synology NAS system untouched to be upgrade-proof. This is the reason why caddy server is used to enable the websocket notifications. Synology do not allow advanced setting of their Nginx reverse proxy and ports 80/443 are not free. We will use the embedded reverse proxy and forward the request on some other ports. This is the reason why Vaultwarden server is not set to use SSL because behind 2 proxies.

Despite this has been made to run on Synology NAS, this should run on other systems with / without minor adaptations.

• Documentation
• Pre-requisite
  • Conventions
• Installation
• Setup
• Startup and Maintenance
  • Startup
  • Maintenance
• Hardening
• To do
• Collaboration

Documentation

• Vaultwarden wiki
• Caddy server 2.0 docs

Pre-requisite

• A Docker compatible Synology NAS
• An up and running Docker package
• A SSH client
• A domain name with Let's Encrypt certs enabled. This part is off-topic here.

Conventions

As convention, we will use as example the following

• The domain : bw.yourdomain.com
• Folder used : /volumeX/docker/ to be personnalized to your DSM setup

Installation

1. Download this repo
2. Unzip and review docker-compose_bitwarden-caddy.yml settings
3. Copy this repo content to /volumeX/docker/

Setup

You will first need to access the admin page to fine tune the Vaultwarden server. Beware, if accessed once, it will be enabled in /data/config.json whatever are the Environment variables. You'll need to disable the admin panel from itself.

1. On Synology's DSM GUI
   1. Go to Settings > Application Portal > Reverse proxy
   2. Add a new entry for HTTPS
      • Name : Bitwarden entry point
      • Source protocol : HTTPS
      • source domain : bw.yourdomain.com
      • port : 443
      • check HSTS and HTTP/2
      • destination protocol : HTTP
      • destination host: localhost
      • port : 8080
      • In Custom Headers tab, click the drop down list next to add button and choose websockets
   3. Add a new entry for HTTP
      • Make sure webstation is running with a dummy page to be served. This is only as fallback.
      • Name : Bitwarden entry point HTTP
      • Source protocol : HTTP
      • source domain : bw.yourdomain.com
      • port : 80
      • destination protocol : HTTP
      • destination host: localhost
      • port : 80
2. Using a terminal, connect through SSH
   1. Connect your admin account with password
   2. Gain root using sudo -i with your admin password
   3. cd /volumeX/docker/
   4. Pull needed images docker-compose -f docker-compose_bitwarden-caddy.yml pull
   5. Ready for a first run : docker-compose -f docker-compose_bitwarden-caddy.yml up

If everything goes well, the prompt will let you know the containers are started and wait until a ctrl + C is triggered to stop them. Test the accesses and start the Birwarden_RS fine tune at https://bw.yourdomain.com/admin. Once finished disable the access to admin panel from itself.

Do not forget to install the clients for desktops, browers and mobile. Test their connection.

Shutdown the servers issuing a ctrl + C in the terminal

Startup and Maintenance

Startup

Once setup is finished, you're ready to launche your "production" server. Review all the settings and environment varaibles in the .yml file. Test it using the same docker-compose -f docker-compose_bitwarden-caddy.yml up as previously. If anything goes well, stop them and run as detached with the following command.

`docker-compose -f docker-compose_bitwarden-caddy.yml up -d`

Maintenance

Upgrade on a regular basis the servers as packages continue to evolve on a daily/weekly basis. From time to time, Run from a terminal the following commands as root.

cd /volumeX/docker/
docker-compose -f docker-compose_bitwarden-caddy.yml down
docker-compose -f docker-compose_bitwarden-caddy.yml pull
docker-compose -f docker-compose_bitwarden-caddy.yml up -d

In order to keep a clean system, from time to time, use this tutoriel.

Hardening

Your Vaultwarden instance is now up and running. It is not yet hardened to brute-force attacks. Please, install Fail2ban to avoid loosing your account control. Here a way to run Fail2Ban in Docker on Synology NAS

To do

Modifying Caddyfile to filter ip addresses allowed to access /admin. Does not work yet on Caddy V2.0 beta20. ipfilter directive not supported

Collaboration

Feel free to propose any optimization through pull requests

docker-bitwarden_rs-caddy-synology's Issues

The SIGNUPS_ALLOWED setting is not disabling signups

I set up a new install based on this repo and I was able to make a new account. I thought there might be an exception for "first account" so I tested again and could make another. I enabled the admin token and saw that signups were allowed according to the admin page. I disabled them there and verified that I could not create more users.

websockets

I couldn't get websocket notifications to work until I added
"websocket_enabled": true,
to my config.json file (in addition to having WEBSOCKET_ENABLED='true' in my docker-compose.yml file.)

DSM Let's Encrypt Process

Hello,
Thank you for this and the fail2ban contribution. The instructions were great and I am able to reach BW through the HTTPS subdomain. Though tinkering with things, it seems I'm not able to get a valid certificate through the DSM process.
Is that even possible? If yes, could you give me some pointers?
Much appreciated!

not accessible to 443

Hello sorry if it’s a dumb question but i can’t find any answers for my requirements

i can’t t open 443 or any ports due ISS provider but i would be happy to run bitwarden on localhost

i am not successful so far to log in bitwarden on local ip because https requested

This browser requires HTTPS to use the web vault Check the Vaultwarden wiki for details on how to enable it

Is this case, is it possible to make it work on my synology nas by by script ?

thank you