How to Install Snipe-IT on Your Synology NAS

How to Install Snipe-IT on Your Synology NAS

Snipe-IT is a free, open source IT asset management system written in PHP. Snipe-IT was made for IT asset management, to enable IT departments to track who has which laptop, when it was purchased, which software licenses and accessories are available, and so on. In this step by step guide I will show you how to install Snipe-IT on your Synology NAS using Docker and Portainer.

💡Note: This guide works perfectly with the latest Snipe-IT v7.1.14 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

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.

Snipe-IT Synology NAS Set up 1 new 2023

  • STEP 5

Now click the “Create” button. Follow the instructions in the image below.

Snipe-IT Synology NAS Set up 2 new 2023

  • 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 SnipeIT. After that, add the following instructions:

Source:
Protocol: HTTPS
Hostname: snipeit.yourname.synology.me
Port: 443

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 1339

Snipe-IT Synology NAS Set up 3 new 2023

  • 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.

Synology Proxy WebSocket

  • STEP 8

On the Reverse Proxy Rules, click the Advanced Settings tab.

  1. Increase the Proxy connection timeout from 60 to 600 seconds.
  2. Increase the Proxy send timeout from 60 to 600 seconds.
  3. Increase the Proxy read timeout from 60 to 600 seconds.

Click Save to save the settings.

Synology NAS Reverse Proxy Timeout

  • STEP 9

Go to Control Panel / Network / Connectivity tab/ Check Enable HTTP/2 then click Apply. Follow the instructions in the image below.

Snipe-IT Synology NAS Set up 4 new 2023

  • STEP 10

Go to Control Panel / Security / Advanced tab/ Check Enable HTTP Compression then click Apply. Follow the instructions in the image below.

Snipe-IT Synology NAS Set up 5 new 2023

  • STEP 11

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

Snipe-IT Synology NAS Set up 6 new 2023

  • STEP 12

Now create two new folders inside the snipeit folder that you created at STEP 11 and name them config and db. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Snipe-IT Synology NAS Set up 7 new 2023

  • STEP 13

Follow my step by step guide on how to activate SMTP for your Gmail account. This step is mandatory. Note: If you don’t want to use the easiest way for SMTP with Google and you already have SMTP details from your own Mail Server, you can just skip this STEP and use your personalized email SMTP details instead.

  • STEP 14

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 15

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

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

services:
  db:
    image: mariadb:11.4-noble #LTS Long Time Support Until May 29, 2029.
    container_name: SNIPE-IT-DB
    security_opt:
      - no-new-privileges:false
    hostname: db
    volumes:
      - /volume1/docker/snipeit/db:/var/lib/mysql:rw
    environment:
      - MYSQL_ROOT_PASSWORD=snipe
      - MYSQL_USER=snipe
      - MYSQL_PASSWORD=snipe
      - MYSQL_DATABASE=snipe
      - TZ=Europe/Bucharest
    restart: on-failure:5
      
  snipeit:
    image: lscr.io/linuxserver/snipe-it:latest
    container_name: SNIPE-IT
    restart: on-failure:5
    healthcheck:
      test: curl -f http://localhost:80/ || exit 1
    depends_on:
      - db
    volumes:
      - /volume1/docker/snipeit/config:/config:rw
    environment:
      - TZ=Europe/Bucharest
      - APP_URL=https://snipeit.yourname.synology.me
      - NGINX_APP_URL=https://snipeit.yourname.synology.me
      - APP_KEY=base64:ivoEDdeb+0ywdn/+d/lF8414TrIwbFOyz8DI187V8vo=
      - APP_FORCE_TLS=true
      - MYSQL_PORT_3306_TCP_ADDR=db
      - MYSQL_PORT_3306_TCP_PORT=3306
      - MYSQL_DATABASE=snipe
      - MYSQL_USER=snipe
      - MYSQL_PASSWORD=snipe
      - PUID=1026
      - PGID=100
      - MAIL_PORT_587_TCP_ADDR=smtp.gmail.com
      - MAIL_PORT_587_TCP_PORT=587
      - MAIL_ENV_FROM_ADDR=Your-own-gmail-address
      - MAIL_ENV_FROM_NAME=Your-own-gmail-address
      - MAIL_ENV_ENCRYPTION=TLS
      - MAIL_ENV_USERNAME=Your-own-gmail-address
      - MAIL_ENV_PASSWORD=Your-own-app-password
    ports:
      - 1339:80

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 for APP_URL and type in your own synology.me DDNS with https:// at the beginning that you have previously created at STEP 6.
Note: Before you paste the code above in the Web editor area below, change the value for NGINX_APP_URL and type in your own synology.me DDNS with https:// at the beginning that you have previously created at STEP 6.
Note: Before you paste the code above in the Web editor area below, change the value for APP_KEY. (Generate your own free APP KEY.)
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.) 1026 is my personal PUID value and 100 is my personal PGID value. You have to type in your own values.
Note: Before you paste the code above in the Web editor area below, change the value for MAIL_ENV_FROM_ADDR and type in your own Gmail address. STEP 13.
Note: Before you paste the code above in the Web editor area below, change the value for MAIL_ENV_FROM_NAME and type in your own Gmail address. STEP 13.
Note: Before you paste the code above in the Web editor area below, change the value for MAIL_ENV_USERNAME and type in your own Gmail address. STEP 13.
Note: Before you paste the code above in the Web editor area below, change the value for MAIL_ENV_PASSWORD and type in your own Gmail app password. STEP 13.

Snipe-IT Synology NAS Set up 8 new 2027

  • STEP 16

Scroll down on the page until you see a button called 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.

Snipe-IT Synology NAS Set up 9 new 2028

  • STEP 17

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

Snipe-IT Synology NAS Set up 10 new 2023

  • STEP 18

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

  • STEP 19

Now open your browser and type in your HTTPS/SSL certificate like this https://snipeit.yourname.synology.me that you have previously created at STEP 6. In my case it’s https://snipeit.mariushosting.synology.me If everything goes right, you will see the Snipe-IT installation page. Click Next: Create Database Tables. Warning: Creating database tables will take some time. Follow the instructions in the image below.

Snipe-IT Synology NAS Set up 11 new 2025

  • STEP 20

After the database tables creation has started; you will get a Synology Error Page or a 504 Gateway Time-out. Just refresh the page in the browser.

Snipe-IT Synology NAS Set up 12 new 2023

  • STEP 21

In some cases after you refresh the page, you will get a 500 SERVER ERROR just refresh the page in the browser again.

Snipe-IT Synology NAS Set up 13 new 2023

  • STEP 22

Click Next: Create User. Follow the instructions in the image below.

Snipe-IT Synology NAS Set up 12 new 2025

  • STEP 23

Create the new user using your own credentials then click Save User. Follow the instructions in the image below.

Snipe-IT Synology NAS Set up 15 new 2023

  • STEP 24

Your Snipe-IT Dashboard at a glance!

Snipe-IT Synology NAS Set up 16 new 2023

  • STEP 25

Download the extra instructions (click on the blue link below) to discover how to upload files bigger than 2MB on SNIPE-IT. 🔒Note: Support my work to unlock the password. You can use this password to download any file on mariushosting forever!

👉🏻PDF Instructions

Enjoy Snipe-IT!

🆘TROUBLESHOOTING

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 Snipe-IT 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 Thursday / November 14th, 2024 at 2:53 PM