VoucherVault is a web application that allows you to manage coupons, vouchers and gift cards digitally. It provides a web portal that is mobile friendly and easy to use. Additionally, it supports expiry notifications via Apprise URLs that will frequently remind you to redeem your stuff. In this step by step guide I will show you how to install VoucherVault on your Synology NAS using Docker & Portainer.
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
Make sure you have a synology.me Wildcard Certificate. Follow my guide to get a Wildcard Certificate. If you already have a synology.me Wildcard certificate, skip this STEP.
STEP 4
Go to Control Panel / Login Portal / Advanced Tab / click Reverse Proxy. Follow the instructions in the image below.
STEP 5
Now click the “Create” button. Follow the instructions in the image below.
STEP 6
After you click the Create button, the window below will open. Follow the instructions in the image below.
On the General area, set the Reverse Proxy Name description: type in Voucher. After that, add the following instructions:
Source:
Protocol: HTTPS
Hostname: voucher.yourname.synology.me
Port: 443
Check Enable HSTS
Destination:
Protocol: HTTP
Hostname: localhost
Port: 8864
STEP 7
On the Reverse Proxy Rules click the Custom Header tab. Click Create and then, from the drop-down menu, click WebSocket. After you click on WebSocket, two Header Names and two Values will be automatically added. Click Save. Follow the instructions in the image below.
STEP 8
Go to Control Panel / Network / Connectivity tab/ Check Enable HTTP/2 then click Apply. Follow the instructions in the image below.
STEP 9
Go to Control Panel / Security / Advanced tab/ Check Enable HTTP Compression then click Apply. Follow the instructions in the image below.
STEP 10
Go to File Station and open the docker folder. Inside the docker folder, create one new folder and name it vouchervault. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.
STEP 11
Now create two new folders inside the vouchervault folder that you created at STEP 10 and name them db and redis. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.
STEP 12
Right click on the vouchervault folder that you have previously created at STEP 10 then click Properties. Follow the instructions in the image below.
STEP 13
Go to the Permission tab then click Advanced options. From the drop-down menu choose “Make inherited permissions explicit“. Follow the instructions in the image below.
STEP 14
Select Everyone then click the Edit tab. Follow the instructions in the image below.
STEP 15
Check all Read and Write Permissions. Click Done. Follow the instructions in the image below.
STEP 16
After you click Done on STEP 15, check “Apply to this folder, sub-folders and files“. Click Save. Follow the instructions in the image below.
STEP 17
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.
STEP 18
In the Name field type in vouchervault. Follow the instructions in the image below.
version: '3.9' services: vouchervault: image: l4rm4nd/vouchervault:latest container_name: VoucherVault healthcheck: test: timeout 10s bash -c ':> /dev/tcp/127.0.0.1/8000' || exit 1 interval: 10s timeout: 5s retries: 3 start_period: 90s environment: - DOMAIN=voucher.yourname.synology.me - ALLOWED_HOSTS=voucher.yourname.synology.me - SECRET_KEY=MariushostingMariushostingMari13 - REDIS_HOST=redis - EXPIRY_THRESHOLD_DAYS=90 # Send notifications xx days prior expiry; default is 30. restart: on-failure:5 ports: - 8864:8000 volumes: - /etc/localtime:/etc/localtime:ro - /etc/TZ:/etc/timezone:ro - /volume1/docker/vouchervault/db:/opt/app/database:rw redis: image: redis:7.2-alpine container_name: VoucherVault-REDIS healthcheck: test: ["CMD-SHELL", "redis-cli ping || exit 1"] restart: on-failure:5 volumes: - /volume1/docker/vouchervault/redis:/data:rw
Note: Before you paste the code above in the Web editor area below, change the value for DOMAIN and type in your own synology.me DDNS that you have previously created at STEP 6 without https:// at the beginning.
Note: Before you paste the code above in the Web editor area below, change the value for ALLOWED_HOSTS and type in your own synology.me DDNS that you have previously created at STEP 6 without https:// at the beginning.
Note: Before you paste the code above in the Web editor area below, change the value for SECRET_KEY and add your own SECRET KEY. MariushostingMariushostingMari13 is an example for a SECRET KEY. You should invent your own Value. Add 32 random characters, both letters and numbers.
STEP 19
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.
STEP 20
If everything goes right, you will see the following message at the top right of your screen: “Success Stack successfully deployed“.
STEP 21
On the left Portainer sidebar, click Containers then check for the VoucherVault container. Click the little log icon. Follow the instructions in the image below.
STEP 22
Copy the Randomly generated password. You will need this password later at STEP 24. Follow the instructions in the image below.
STEP 23
Go back to STEP 1 or you will deal with karma 🙂
STEP 24
Now open your browser and type in your HTTPS/SSL certificate like this https://voucher.yourname.synology.me that you have previously created at STEP 6. In my case it’s https://voucher.mariushosting.synology.me If everything goes right, you will see the VoucherVault login page. Type in the default username and the Randomly generated password that you have previously copied at STEP 22, then click Log in. Follow the instructions in the image below.
STEP 25
At the top right of the VoucherVault page, click admin then Change Password to change the previous Randomly generated password with your own unique password. Follow the instructions in the image below.
STEP 26
Create your first item. Follow the instructions in the image below.
STEP 27
All the items that you have created will be visible in the Inventory.
STEP 28
Your VoucherVault dashboard at a glance!
Enjoy VoucherVault!
If you encounter issues by using this container, make sure to check out the Common Docker issues article.
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 VoucherVault 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.
This post was updated on Saturday / October 5th, 2024 at 8:52 AM