GitQlient is an application to manage and operate one or several Git repositories. With GitQlient you will be able to add commits, branches and manage all the options Git provides. GitQlient, pronounced as git+client, is a multi-platform Git client originally forked from QGit. Nowadays it goes beyond just a fork and adds a lot of new functionality. In this step by step guide I will show you how to install GitQlient on your Synology NAS with Docker & Portainer.
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.
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.
Go to Control Panel / Login Portal / Advanced Tab / click Reverse Proxy. Follow the instructions in the image below.
Now click the “Create” button. Follow the instructions in the image below.
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 GitQlient. After that, add the following instructions:
Check Enable HSTS
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.
Go to Control Panel / Network / Connectivity tab/ Check Enable HTTP/2 then click Apply. Follow the instructions in the image below.
Go to Control Panel / Security / Advanced tab/ Check Enable HTTP Compression then click Apply. Follow the instructions in the image below.
Go to File Station and open the docker folder. Inside the docker folder, create one new folder and name it gitqlient. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.
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.
In the Name field type in gitqlient. Follow the instructions in the image below.
version: "3.9" services: gitqlient: image: ghcr.io/linuxserver/gitqlient:latest container_name: GitQlient hostname: gitqlient mem_limit: 2g shm_size: 1g cpu_shares: 1024 security_opt: - seccomp:unconfined healthcheck: test: curl -f http://localhost:3000/ || exit 1 ports: - 3402:3000 - 3403:3001 volumes: - /volume1/docker/gitqlient:/config:rw environment: TZ: Europe/Bucharest PUID: 1026 PGID: 100 TITLE: GitQlient restart: on-failure:5
Note: Before you paste the code above in the Web editor area below, change the value for TZ. (Select your current Time Zone from this list.)
Note: Before you paste the code above in the Web editor area below, change the value numbers for PUID and PGID with your own values. (Follow my step by step guide on how to do this.) 1026 is my personal PUID value and 100 is my personal PGID value. You have to type in your own values.
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.
If everything goes right, you will see the following message at the top right of your screen: “Success Stack successfully deployed“.
Go back to STEP 1 or you will deal with karma 🙂
Now open your browser and type in your HTTPS/SSL certificate like this https://gitqlient.yourname.synology.me that you have previously created at STEP 6. In my case it’s https://gitqlient.mariushosting.synology.me If everything goes right, you will see the GitQlient Login page. Follow the instructions in the image below.
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: Find out how to update the GitQlient 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 Monday / September 18th, 2023 at 8:26 AM