How to Install KeePassXC on Your Synology NAS

How to Install KeePassXC on Your Synology NAS

KeePassXC is a free and open-source password manager. It started as a community fork of KeePassX. It is built using Qt5 libraries, making it a multi-platform application which can be run on NAS, Linux, Windows, macOS, and BSD. KeePassXC uses the KeePass 2.x password database format natively. In this step by step guide I will show you how to install KeePassXC on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest KeePassXC v2.7.7 release.

  • STEP 1

Please Support My work by Making a Donation.

  • STEP 2

Install Portainer using my step by step guide. If you already have Portainer installed on your Synology NAS, skip this STEP. Attention: Make sure you have installed the latest Portainer version.

  • STEP 3

Go to File Station and open the docker folder. Inside the docker folder, create one new folder and name it keepassxc. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

KeePassXC Synology NAS Set up 1

  • STEP 4

Log into Portainer using your username and password. On the left sidebar in Portainer, click on Stacks then + Add stack. Follow the instructions in the image below.

1 Synology Portainer Add Stack

  • STEP 5

In the Name field type in keepassxc. Follow the instructions in the image below.

Note: Copy Paste the code below in the Portainer Stacks Web editor.

version: "3.9"
services:
  keepassxc:
    container_name: KeePassXC
    image: ghcr.io/linuxserver/keepassxc:latest
    security_opt:
      - no-new-privileges:false
      - seccomp:unconfined
    healthcheck:
      test: timeout 10s bash -c ':> /dev/tcp/127.0.0.1/3000' || exit 1
      interval: 10s
      timeout: 5s
      retries: 3
      start_period: 90s
    environment:
     CUSTOM_USER: marius
     PASSWORD: mariushosting
     TZ: Europe/Bucharest
     PUID: 1026
     PGID: 100
    volumes:
      - /volume1/docker/keepassxc:/config:rw
    ports:
      - 3426:3000
    restart: on-failure:5

Note: Before you paste the code above in the Web editor area below, change the value for CUSTOM_USER. Type in your own username. marius is an example for a username.
Note: Before you paste the code above in the Web editor area below, change the value for PASSWORD. Type in your own password. mariushosting is an example for a password.
Note: Before you paste the code above in the Web editor area below, change the value for TZ. (Select your current Time Zone from this list.)
Note: Before you paste the code above in the Web editor area below, change the value numbers for PUID and PGID with your own values. (Follow my step by step guide on how to do this.)

KeePassXC Synology NAS Set up 2

  • STEP 6

Scroll down on the page until you see a button named Deploy the stack. Click on it. Follow the instructions in the image below. The installation process can take up to a few minutes. It will depend on your Internet speed connection.

KeePassXC Synology NAS Set up 3

⌛Now just wait because the KeePassXC image is about 1.4GB.

  • STEP 7

If everything goes right, you will see the following message at the top right of your screen: “Success Stack successfully deployed“.

KeePassXC Synology NAS Set up 4

  • STEP 8

Go back to STEP 1 or you will deal with karma 🙂

  • STEP 9

The installation process can take up to a few seconds/minutes. It will depend on your Internet speed connection. Now open your browser and type in http://Synology-ip-address:3426 If everything goes right, you will see the KeePassXC Login page. Type in your own CUSTOM_USER and PASSWORD that you have previously created at STEP 5 then click Sign In. Follow the instructions in the image below.

KeePassXC Synology NAS Set up 5

  • STEP 10

Click Create Database. Follow the instructions in the image below.

KeePassXC Synology NAS Set up 6

  • STEP 11

Give a Name and Description to the database, then click Continue. Follow the instructions in the image below.

KeePassXC Synology NAS Set up 7

  • STEP 12

Click Continue. Follow the instructions in the image below.

KeePassXC Synology NAS Set up 8

  • STEP 13

Add a database Password, then click Done. Follow the instructions in the image below.

KeePassXC Synology NAS Set up 9

  • STEP 14

Click Save. Follow the instructions in the image below.

KeePassXC Synology NAS Set up 10

  • STEP 15

Your KeePassXC dashboard at a glance!

KeePassXC Synology NAS Set up 11

Enjoy KeePassXC!

🆘TROUBLESHOOTING

If you encounter issues by using this container, make sure to check out the Common Docker issues article.

Note: If you want to run the KeePassXC container over HTTPS, check How to Run Docker Containers Over HTTPS. In order to make KeePassXC work via HTTPS, it’s mandatory to activate WebSocket.

Note: Can I run Docker on my Synology NAS? See the supported models.
Note: How to Back Up Docker Containers on your Synology NAS.
Note: Find out how to update the KeePassXC container with the latest image.
Note: How to Free Disk Space on Your NAS if You Run Docker.
Note: How to Schedule Start & Stop For Docker Containers.
Note: How to Activate Email Notifications.
Note: How to Add Access Control Profile on Your NAS.
Note: How to Change Docker Containers Restart Policy.
Note: How to Use Docker Containers With VPN.
Note: Convert Docker Run Into Docker Compose.
Note: How to Clean Docker.
Note: How to Clean Docker Automatically.
Note: Best Practices When Using Docker and DDNS.
Note: Some Docker Containers Need WebSocket.
Note: Find out the Best NAS Models For Docker.
Note: Activate Gmail SMTP For Docker Containers.

This post was updated on Friday / May 3rd, 2024 at 9:08 PM