How to Install EverShop on Your Synology NAS

How to Install EverShop on Your Synology NAS

EverShop is an open-source Node ecommerce platform that helps developers develop their e-commerce store. Based on a module system, EverShop is flexible, with both the admin panel and the front store being extensible. EverShop also offers rich functionality, enabling merchants to develop a web store that meets business requirements. In this step by step guide I will show you how to install EverShop on your Synology NAS using Docker and Portainer.

💡Note: This guide works perfectly with the latest EverShop v1.0.0 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.

EverShop Synology NAS Set up 1

  • STEP 5

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

EverShop Synology NAS Set up 2

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

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

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 3101

EverShop Synology NAS Set up 3

  • 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

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

EverShop Synology NAS Set up 4

  • STEP 9

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

EverShop Synology NAS Set up 5

  • STEP 10

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

EverShop Synology NAS Set up 6

  • STEP 11

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 12

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

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

version: "3.9"
services:
  db:
    image: postgres:16
    container_name: EverShop-DB
    hostname: db
    mem_limit: 1g
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: ["CMD", "pg_isready", "-q", "-d", "evershop", "-U", "evershopsuser"]
      timeout: 45s
      interval: 10s
      retries: 10
    volumes:
      - /volume1/docker/evershopdb:/var/lib/postgresql/data:rw
    environment:
      POSTGRES_DB: evershop
      POSTGRES_USER: evershopuser
      POSTGRES_PASSWORD: evershopass
    restart: on-failure:5

  evershop:
    image: evershop/evershop:latest
    container_name: EverShop
    hostname: evershop
    security_opt:
      - no-new-privileges:true
    ports:
      - 3101:3000
    environment:
       DB_HOST: db
       DB_PORT: 5432
       DB_PASSWORD: evershopass
       DB_USER: evershopuser
       DB_NAME: evershop
       NODE_ENV: production
    depends_on:
      - db

EverShop Synology NAS Set up 7

  • STEP 13

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.

EverShop Synology NAS Set up 8

  • STEP 14

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

EverShop Synology NAS Set up 9

  • STEP 15

On the left sidebar in Portainer, click Containers. Identify your EverShop instance, then click on the little terminal icon. Follow the instructions in the image below.

EverShop Synology NAS Set up 10

  • STEP 16

After you click on the little terminal icon at STEP 15, a new page will open. Select /bin/ash from the dropdown menu, then click Connect. Follow the instructions in the image below.

EverShop Synology NAS Set up 11

  • STEP 17

After you click Connect at STEP 16, a Console will open. Copy paste the code below and confirm by pressing Enter on your keyboard to start the admin creation process. Follow the instructions in the image below. Note: Type in your own email, password and name instead of the ones in the example below.

npm run user:create -- --email "supergate84@gmail.com" --password "mariushosting" --name "Marius"

EverShop Synology NAS Set up 12

  • STEP 18

Wait until the Admin creation wizard is finished. After the Admin creation, you will see a message that says: “Admin user created successfully“. Follow the instructions in the image below.

EverShop Synology NAS Set up 13

  • STEP 19

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

  • STEP 20

Now open your browser and type in your HTTPS/SSL certificate like this https://evershop.yourname.synology.me/admin/login that you have previously created at STEP 6. In my case it’s https://evershop.mariushosting.synology.me/admin/login If everything goes right, you will see the EverShop login page. Type in your Email address and your own Password that you have previously created at STEP 17. Click Login. Follow the instructions in the image below.

EverShop Synology NAS Set up 14

  • STEP 21

Your EverShop Admin Dashboard at a glance!

EverShop Synology NAS Set up 15

  • STEP 22

https://evershop.yourname.synology.me/admin/login will be your admin dashboard page and https://evershop.yourname.synology.me will be your EverShop front page.

EverShop Synology NAS Set up 16

Enjoy EverShop!

Note: EverShop Full Documentation.

🆘TROUBLESHOOTING

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

Note: Find out how to update the EverShop container with the latest image.
Note: Can I run Docker on my Synology NAS? See the supported models.
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 Saturday / January 13th, 2024 at 7:03 PM