Gitness is an open source development platform from Harness that unifies managing your source code repositories and development lifecycle pipelines. Gitness is packed with the power of code hosting and automated DevOps pipelines. In this step by step guide I will show you how to install Gitness on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest Gitness v3.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.

• STEP 5

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

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

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

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 3745

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

• STEP 8

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

• STEP 9

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

• STEP 10

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

• STEP 11

Now create three new folders inside the gitness folder that you created at STEP 10 and name them data, db, git. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

• STEP 12

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.

• STEP 13

In the Name field type in gitness. 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: Gitness-DB
    hostname: gitness-db
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: ["CMD", "pg_isready", "-q", "-d", "gitness", "-U", "gitnessuser"]
      timeout: 45s
      interval: 10s
      retries: 10
    volumes:
      - /volume1/docker/gitness/db:/var/lib/postgresql/data:rw
    environment:
      POSTGRES_DB: gitness
      POSTGRES_USER: gitnessuser
      POSTGRES_PASSWORD: gitnesspass
    restart: on-failure:5

  gitness:
    image: harness/gitness:latest
    container_name: Gitness
    hostname: gitness
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: ["CMD-SHELL", "nc -z 127.0.0.1 3000 || exit 1"]
      interval: 10s
      timeout: 5s
      retries: 3
      start_period: 90s
    ports:
      - 3745:3000
    environment:
      GITNESS_DATABASE_DRIVER: postgres
      GITNESS_DATABASE_DATASOURCE: 'postgres://gitnessuser:gitnesspass@gitness-db:5432/gitness?sslmode=disable'
      GITNESS_GRACEFUL_SHUTDOWN_TIME: 600s
      GITNESS_PRINCIPAL_ADMIN_EMAIL: yourown@email
      GITNESS_PRINCIPAL_ADMIN_PASSWORD: mariushosting
      GITNESS_TOKEN_COOKIE_NAME: MariushostingMariushostingMarixx
      GITNESS_TOKEN_EXPIRE: 1000h
      GITNESS_URL_API: http://localhost:3000/api
      GITNESS_URL_GIT: http://localhost:3000/git
      GITNESS_URL_BASE: https://gitness.yourname.synology.me
      GITNESS_REGISTRY_HTTP_SECRET: B34GfDbF3FEsAYlIP0vgXcd1I4e8eGmV
      GITNESS_USER_SIGNUP_ENABLED: true
    volumes:
      - /volume1/docker/gitness/data:/data:rw
      - /volume1/docker/gitness/git:/git:rw
      - /var/run/docker.sock:/var/run/docker.sock
    restart: on-failure:5
    depends_on:
      db:
        condition: service_healthy

Note: Before you paste the code above in the Web editor area below, change the value for GITNESS_PRINCIPAL_ADMIN_EMAIL and type in your own email. You will need this email later at STEP 17.
Note: Before you paste the code above in the Web editor area below, change the value for GITNESS_PRINCIPAL_ADMIN_PASSWORD and type in your own password. You will need this password later at STEP 17.
Note: Before you paste the code above in the Web editor area below, change the value for GITNESS_TOKEN_COOKIE_NAME and add your own COOKIE SECRET KEY. MariushostingMariushostingMari13 is an example for a COOKIE SECRET KEY. You should invent your own Value. Add 32 random characters, only letters, NOT numbers.
Note: On the Environment variables change the value for GITNESS_URL_BASE. Type in your own synology.me DDNS that you have previously created at STEP 6 with https at the beginning.
Note: Before you paste the code above in the Web editor area below, change the value for GITNESS_REGISTRY_HTTP_SECRET. (Generate your own 32 length GITNESS_REGISTRY_HTTP_SECRET.)

• STEP 14

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.

• STEP 15

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

• STEP 16

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

• STEP 17

Now open your browser and type in your HTTPS/SSL certificate like this https://gitness.yourname.synology.me that you have previously created at STEP 6. In my case it’s https://gitness.mariushosting.synology.me If everything goes right, you will see the main Gitness login page. Type in your own GITNESS_PRINCIPAL_ADMIN_EMAIL and GITNESS_PRINCIPAL_ADMIN_PASSWORD that you have previously created at STEP 13. Click Sign in. Follow the instructions in the image below.

• STEP 18

Click + New Project to add your first Project. Follow the instructions in the image below.

Enjoy Gitness!

🆘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 Gitness container with the latest image.
Note: How to Back Up Docker Containers on your Synology NAS.
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 Tuesday / October 8th, 2024 at 12:57 AM