How to Install OneDev on Your Synology NAS

How to Install OneDev on Your Synology NAS

OneDev is an all-in-one DevOps platform that features Git repository management with language-aware code search, issue management with custom states and fields, and a docker-first Kubernetes native build/CI engine. An alternative to GitLab, it is easier to use and maintain, with lots of unique features. In this step by step guide I will show you how to install OneDev on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest OneDev v11.6.3 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.

OneDev Synology NAS Set up 1

  • STEP 5

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

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

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

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 6610

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

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

 

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

OneDev 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 onedev. Follow the instructions in the image below.

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

services:
  onedev:
    image: 1dev/server:latest
    container_name: OneDev
    hostname: onedev
    healthcheck:
      test: timeout 10s bash -c ':> /dev/tcp/127.0.0.1/6610' || exit 1
      interval: 10s
      timeout: 5s
      retries: 3
      start_period: 90s
    ports:
      - 6610:6610/tcp
    volumes:
      - /etc/localtime:/etc/localtime:ro
      - /etc/TZ:/etc/timezone:ro
      - /var/run/docker.sock:/var/run/docker.sock:ro
      - /volume1/docker/onedev:/opt/onedev:rw
    environment:
       initial_user: marius
       initial_password: mariushosting
       initial_email: yourown@email
       initial_server_url: https://onedev.yourname.synology.me

Note: Before you paste the code above in the Run command area below, change the value for initial_user. Add your own username. marius is an example for a username. You should use your own username.
Note: Before you paste the code above in the Run command area below, change the value for initial_password. Add your own password. mariushosting is an example for a password. You should use your own password.
Note: Before you paste the code above in the Run command area below, change the value for initial_email. Add your own Email Address.
Note: Before you paste the code above in the Web editor area below, change the value for initial_server_url and type in your own synology.me DDNS with https:// at the beginning that you have previously created at STEP 6.

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

OneDev Synology NAS Set up 8

  • STEP 14

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

OneDev Synology NAS Set up 9

  • 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://onedev.yourname.synology.me that you have previously created at STEP 6. In my case it’s https://onedev.mariushosting.synology.me Type in your own Username (initial_user) and Password (initial_password) that you have previously added at STEP 12, then click Sign in. Follow the instructions in the image below.

OneDev Synology NAS Set up 10

  • STEP 17

Your OneDev dashboard at a glance!

OneDev Synology NAS Set up 11

Enjoy OneDev!

🆘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 OneDev 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 Sunday / December 8th, 2024 at 4:09 PM