How to Install Hauk on Your Synology NAS

How to Install Hauk on Your Synology NAS

Hauk is a fully open source, self-hosted Location Sharing Service. Install the backend code on a PHP-compatible web server, install the companion app on your phone, and you’re good to go! In this step by step guide I will show you how to install Hauk on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest version of Hauk v1.6.2

  • 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

Install Text Editor via Synology “Package Center”. (Mandatory STEP.) If you already have Text Editor installed on your Synology NAS, skip this STEP.

Synology Install Text Editor 2023

  • STEP 5

Go to Control Panel / Login Portal / Advanced Tab / click Reverse Proxy. Follow the instructions in the image below.

Hauk Synology NAS Set up 1

  • STEP 6

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

Hauk Synology NAS Set up 2

  • STEP 7

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

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

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 9435

Hauk Synology NAS Set up 3

  • STEP 8

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 9

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

Hauk Synology NAS Set up 4

  • STEP 10

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

Hauk Synology NAS Set up 5

  • STEP 11

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

Hauk Synology NAS Set up 6

  • STEP 12

Download (click on the blue link below) then upload the config.php file below in the hauk folder that you have previously created at STEP 11. Follow the instructions in the image below. 🔒Note: Support my work to unlock the password. You can use this password to download any file on mariushosting forever!

👉🏻config.php

Hauk Synology NAS Set up 7

  • STEP 13

Open the config.php file then scroll down until the end. Type in your own synology.me DDNS that you have previously created at STEP 6 with https at the beginning inside the quotation marks. Follow the instructions in the image below.

Hauk Synology NAS Set up 8

  • STEP 14

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 15

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

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

version: "3.9"
services:
  hauk:
    image: bilde2910/hauk:latest
    container_name: Hauk
    hostname: hauk
    mem_limit: 4g
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: curl -f http://localhost:80/ || exit 1
    ports:
      - 9435:80
    volumes:
      - /volume1/docker/hauk:/etc/hauk:rw
    restart: on-failure:5

Hauk Synology NAS Set up 9

  • STEP 16

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.

Hauk Synology NAS Set up 10

  • STEP 17

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

Hauk Synology NAS Set up 11

  • STEP 18

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

  • STEP 19

Now open your browser and type in your HTTPS/SSL certificate like this https://hauk.yourname.synology.me In my case it’s https://hauk.mariushosting.synology.me If everything goes right you will see the Hauk homepage. Download the Hauk app on your Android phone. Follow the instructions in the image below.

Hauk Synology NAS Set up 12

  • STEP 20

Search for the Hauk app on your Android phone, then install it. Follow the instructions in the image below.

Hauk Synology NAS Set up 13

  • STEP 21

Once the Hauk app is installed, at the top right of the app, click the gear icon. Follow the instructions in the image below.

Hauk Synology NAS Set up 14

  • STEP 22

On the Server URL area, type in your own synology.me DDNS that you have previously created at STEP 6 with https at the beginning, then click OK. Follow the instructions in the image below.

Hauk Synology NAS Set up 15

  • STEP 23

Once the connection is established, click OK. Follow the instructions in the image below.

Hauk Synology NAS Set up 16

  • STEP 24

Create a new sharing link, then share your location with your Family or Friends. Follow the instructions in the image below.

Hauk Synology NAS Set up 17

  • STEP 25

Your location at a glance!

Hauk Synology NAS Set up 18

Enjoy Hauk!

🆘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 Hauk 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 Container

This post was updated on Saturday / February 24th, 2024 at 6:04 AM