How to Install Hauk on POP! OS

In this tutorial, we will guide you through the process of installing Hauk on the latest version of POP! OS. Hauk is a self-hosted location sharing web application that allows you to share your location in real-time with your friends and family.

To get started, you will need a few things:

A computer running the latest version of POP! OS
A web server with PHP support (we recommend Apache or Nginx)
A domain name or a subdomain pointing to the IP address of your web server

Step 1 – Install Prerequisites

Before we start installing Hauk, we need to ensure that our system has all the necessary software and packages installed.

First, let's update the package list:

sudo apt update

Next, install the required packages:

sudo apt install php7.4 php7.4-mbstring php7.4-gd php7.4-zip php7.4-xml composer

This command will install PHP 7.4 and some necessary extensions and Composer, which we will use to install the dependencies for Hauk.

Step 2 – Install Hauk

To install Hauk, we need to clone the Git repository and install the dependencies using Composer.

First, navigate to your web server's document root directory:

cd /var/www/html

Next, clone the Git repository:

sudo git clone https://github.com/bilde2910/Hauk.git hauk

Now, change the current directory to the Hauk directory:

cd hauk

Finally, install the dependencies using Composer:

sudo composer install

Step 3 – Configure Hauk

Now that Hauk is installed, we need to configure it.

First, copy the example configuration file:

sudo cp config.inc.php.example config.inc.php

Next, edit the configuration file:

sudo nano config.inc.php

Change the following settings:

$config['secret_key'] – Change this to a strong secret key.
$config['map_provider'] – Change this to your preferred map provider (e.g., "leaflet", "openstreetmap").
$config['base_uri'] – Change this to the URL or subdomain you want to use for Hauk (e.g., "https://hauk.example.com").

Save and close the file.

Step 4 – Configure Web Server

We need to configure our web server to serve Hauk.

Apache

If you're using Apache, create an Apache virtual host configuration file:

sudo nano /etc/apache2/sites-available/hauk.conf

Add the following content:

<VirtualHost *:80>
    ServerName hauk.example.com
    DocumentRoot /var/www/html/hauk

    <Directory /var/www/html/hauk>
        Options -Indexes +FollowSymLinks
        AllowOverride All
        Require all granted
    </Directory>
    
    ErrorLog ${APACHE_LOG_DIR}/hauk_error.log
    CustomLog ${APACHE_LOG_DIR}/hauk_access.log combined
    
    <IfModule mod_rewrite.c>
        RewriteEngine on
        RewriteCond %{REQUEST_FILENAME} !-f
        RewriteCond %{REQUEST_FILENAME} !-d
        RewriteRule . /index.php [L]
    </IfModule>
</VirtualHost>

Save and close the file.

Enable the virtual host:

sudo a2ensite hauk.conf

Restart Apache to apply the changes:

sudo systemctl restart apache2

Nginx

If you're using Nginx, create an Nginx server block configuration file:

sudo nano /etc/nginx/sites-available/hauk

Add the following content:

server {
    listen 80;
    server_name hauk.example.com;

    root /var/www/html/hauk;

    index index.php;

    location / {
        try_files $uri $uri/ /index.php?$query_string;
    }

    location ~ \.php$ {
        include fastcgi_params;
        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
        fastcgi_pass unix:/run/php/php7.4-fpm.sock;
    }
}

Save and close the file.

Enable the server block:

sudo ln -s /etc/nginx/sites-available/hauk /etc/nginx/sites-enabled/hauk

Restart Nginx to apply the changes:

sudo systemctl restart nginx

Step 5 – Create User

Finally, we need to create a user account to access Hauk.

To create a user, run the following command:

sudo php cli/user.php create username

Replace username with your desired username.

You will be prompted to enter a password for the user.

Step 6 – Access Hauk

Now that we have configured everything, we can access Hauk using a web browser.

Navigate to the URL or subdomain you configured in step 3 (e.g., "https://hauk.example.com").

Congratulations! You have successfully installed and configured Hauk on POP! OS.