How to Install Cryptgeon on Your Synology NAS

How to Install Cryptgeon on Your Synology NAS

Cryptgeon is a secure, open source sharing note or file service inspired by PrivNote, written in rust and svelte. Each document note has a 512bit generated id that is used to retrieve the note. All the data you create through cryptgeon is stored in memory (RAM) and never persists/stays on your disk on the NAS. In this step by step guide I will show you how to install Cryptgeon on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest Cryptgeon v2.4.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.

Cryptgeon Synology NAS Set up 1 new 2023

  • STEP 5

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

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

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

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 8120

Cryptgeon 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

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

Cryptgeon Synology NAS Set up 4 new 2023

  • STEP 9

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

Cryptgeon Synology NAS Set up 5 new 2023

  • STEP 10

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

Cryptgeon Synology NAS Set up new1 2024

  • STEP 11

Log into Portainer using your username and password. On the Portainer left sidebar 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 cryptgeon. Follow the instructions in the image below.

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

version: '3.9'
services:
  redis:
    image: redis:7-alpine
    container_name: Cryptgeon-REDIS
    healthcheck:
      test: ["CMD-SHELL", "redis-cli ping || exit 1"]
    volumes:
      - /volume1/docker/cryptgeon:/data:rw
  app:
    image: cupcakearmy/cryptgeon
    container_name: Cryptgeon
    healthcheck:
      test: ["CMD", "curl", "--fail", "http://127.0.0.1:8000/api/live/"]
      interval: 1m
      timeout: 5s
      retries: 3
      start_period: 5s
    depends_on:
      - redis
    environment:
      SIZE_LIMIT: 16 MiB
    ports:
      - 8120:8000

Note: Before you paste the code above in the Web editor area below, change the value for SIZE_LIMIT with your preference, for example 32 MiB instead of 16 MiB etc.

2 Cryptgeon Synology NAS Set up new 2024

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

3 Cryptgeon Synology NAS Set up new 2024

  • STEP 14

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

4 Cryptgeon Synology NAS Set up new 2024

  • STEP 15

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

  • STEP 16

Now open your browser and type in your HTTPS/SSL certificate like this https://cryptgeon.yourname.synology.me that you have previously created at STEP 6. In my case it’s https://cryptgeon.mariushosting.synology.me If everything goes right, you will see the main Cryptgeon page. Add your own text then click Create. Follow the instructions in the image below. Note: You can also switch to the dark mode theme.

Cryptgeon Synology NAS Set up 6

  • STEP 17

After you click Create on STEP 16, you can copy and share the note with whomever you want. Follow the instructions in the image below.

Cryptgeon Synology NAS Set up 7

  • STEP 18

The person accessing the link you provided will have to click on show note to see it. Follow the instructions in the images below.

Cryptgeon Synology NAS Set up 8

They can also copy the note to their clipboard.

Cryptgeon Synology NAS Set up 9

  • STEP 19

If someone attempts to access the link and you set up a retention policy on STEP 16, they will get a warning message saying that “note was not found or was already deleted”.

Cryptgeon Synology NAS Set up 10

  • STEP 20

Instead of a note, you also have the option to drag and drop a file from your own computer, with the retention policy of your choice. Follow the instructions in the image below.

Cryptgeon Synology NAS Set up 11

  • STEP 21

After you provide someone with the link, they can download the file/files. Follow the instructions in the image below.

Cryptgeon Synology NAS Set up 12

Enjoy Cryptgeon!

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 Cryptgeon 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 Saturday / February 24th, 2024 at 6:41 AM