How to Install Maybe on Your Synology NAS

How to Install Maybe on Your Synology NAS

Maybe is a fully open-source OS for your personal finances. You will have at your disposal all the interactive tools and calculators you need to visualize and navigate your financial journey. In this step by step guide I will show you how to install Maybe on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest version of Maybe v0.1.0

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

Maybe Synology NAS Set up 1

  • STEP 5

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

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

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

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 5488

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

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

Maybe 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 maybe. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Maybe Synology NAS Set up 6

  • STEP 11

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

Maybe Synology NAS Set up 7

  • STEP 12

Right click on the storage folder that you have previously created at STEP 11 then click Properties. Follow the instructions in the image below.

Maybe Synology NAS Set up 8

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

Maybe Synology NAS Set up 9

  • STEP 14

Select Everyone then click the Edit tab. Follow the instructions in the image below.

Maybe Synology NAS Set up 10

  • STEP 15

Check all Read and Write Permissions. Click Done. Follow the instructions in the image below.

Maybe Synology NAS Set up 11

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

Maybe Synology NAS Set up 12

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

1 Synology Portainer Add Stack

  • STEP 18

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

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

services:
  db:
    image: postgres:17
    container_name: Maybe-DB
    hostname: maybe-db
    mem_limit: 1g
    cpu_shares: 1024
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: ["CMD", "pg_isready", "-q", "-d", "maybe", "-U", "maybeuser"]
      timeout: 45s
      interval: 10s
      retries: 10
    volumes:
      - /volume1/docker/maybe/db:/var/lib/postgresql/data:rw
    environment:
      POSTGRES_DB: maybe
      POSTGRES_USER: maybeuser
      POSTGRES_PASSWORD: maybepass
    restart: on-failure:5

  maybe:
    image: ghcr.io/maybe-finance/maybe:latest
    container_name: Maybe
    healthcheck:
       test: timeout 10s bash -c ':> /dev/tcp/127.0.0.1/3000' || exit 1
       interval: 10s
       timeout: 5s
       retries: 3
       start_period: 90s
    volumes:
      - /volume1/docker/maybe/storage:/rails/storage:rw
    ports:
      - 5488:3000
    restart: on-failure:5
    environment:
      SELF_HOSTED: true
      RAILS_FORCE_SSL: true
      RAILS_ASSUME_SSL: true
      GOOD_JOB_EXECUTION_MODE: async
      SECRET_KEY_BASE: 80VLppsKg3r4wuWZYc75PU8OE1p9ye5z
      DB_HOST: db
      POSTGRES_DB: maybe
      POSTGRES_USER: maybeuser
      POSTGRES_PASSWORD: maybepass
    depends_on:
      db:
        condition: service_healthy

Note: Before you paste the code above in the Web editor area below, change the value for SECRET_KEY_BASE. (Generate your own 32 length SECRET_KEY_BASE.)

Maybe Synology NAS Set up 13

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

Maybe Synology NAS Set up 14

  • STEP 20

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

Maybe Synology NAS Set up 15

  • STEP 21

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

  • STEP 22

Now open your browser and type in your HTTPS/SSL certificate like this https://maybe.yourname.synology.me that you have previously created at STEP 6. In my case it’s https://maybe.mariushosting.synology.me Click Set up account. Follow the instructions in the image below.

Maybe Synology NAS Set up 16

  • STEP 22

Type in your own details, then click Continue. Follow the instructions in the image below.

Maybe Synology NAS Set up 17

  • STEP 23

Configure your preferences, then click Complete. Follow the instructions in the image below.

Maybe Synology NAS Set up 18

  • STEP 24

Click New account to start the magic!

Maybe Synology NAS Set up 19

Enjoy Maybe!

🆘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 Maybe 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 / October 24th, 2024 at 6:51 AM