Hauk

alt="Get it on F-Droid" height="80">](https://f-droid.org/packages/info.varden.hauk)

alt="Get it on Google Play" height="80">](https://play.google.com/store/apps/details?id=info.varden.hauk)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!

System Requirements

• Web server running PHP and Memcached or Redis.
• PHP memcached, memcache or redis extension installed on the web server.
• PHP ldap extension if using LDAP authentication.
• Android 6 or above to run the companion Android app.

Installation instructions

1. Clone or download this repository: git clone https://github.com/bilde2910/Hauk.git
2. Run sudo ./install.sh -c web_root where web_root is the folder you want

to install Hauk in, for example `/var/www/html`. Follow the instructions
given by the install script. Make sure to set a secure hashed password and
edit your site's domain in the configuration file after installation.

1. Start the web server and make sure Memcached or Redis is running and

[properly configured and firewalled](https://github.com/bilde2910/Hauk/wiki/FAQ#how-do-i-securely-configure-memcachedredis).

1. Install the companion Android app (from your favourite store linked above)

on your phone and enter your server's settings.

Manual installation

1. Clone or download this repository: git clone https://github.com/bilde2910/Hauk.git
2. Copy all files in the backend-php and frontend folders to a common folder

in your web root, for example `/var/www/html`.

1. Modify include/config.php to your liking. Make sure to set a secure hashed

password and edit your site's domain in this file.

1. Start the web server and make sure Memcached or Redis is running and

[properly configured and firewalled](https://github.com/bilde2910/Hauk/wiki/FAQ#how-do-i-securely-configure-memcachedredis).

1. Install the companion Android app (from your favourite store linked above)

on your phone and enter your server's settings.

Distribution-specific packages

Arch Linux

Via Docker Compose

version: '3.4'

services:
  hauk:
    image: bilde2910/hauk
    container_name: hauk
    volumes:
      - ./config/hauk:/etc/hauk

server {
    listen 443 ssl;

    ssl_protocols TLSv1.2 TLSv1.3;
    ssl_ciphers 'ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305';
    ssl_session_cache shared:SSL:10m;
    ssl_stapling on;
    ssl_stapling_verify on;

    ssl_ecdh_curve 'secp521r1:secp384r1';
    ssl_prefer_server_ciphers on;
    ssl_session_timeout 10m;
    ssl_session_tickets off;

    ssl_certificate /etc/letsencrypt/live/hauk.example.com/fullchain.pem;
    ssl_certificate_key /etc/letsencrypt/live/hauk.example.com/privkey.pem;

    add_header Referrer-Policy same-origin always;
    add_header X-Frame-Options DENY always;
    add_header X-Content-Type-Options nosniff always;
    add_header X-XSS-Protection "1; mode=block" always;
    add_header X-Robots-Tag "noindex, nofollow" always;

    server_name hauk.example.com;

    location / {
        proxy_pass http://hauk:80;
    }
}

Upgrading to newer versions

• Major updates add breaking changes that either require manual intervention, or breaks backward compatibility. Update instructions for major versions will be listed in the release notes, as well as either this README or in the wiki. To date there have been no major updates.
• Minor updates add functionality, but does not break backward compatibility. You can still use an older client on a newer server, or a newer client on an older server, though some functionality may be missing. This will be dynamically detected by the client and server, which could e.g. lead to some UI elements being disabled in the app, or a notification made if a user tries to use new functionality that the other endpoint does not support.
• Patch updates are primarily bugfixes.

Demo server

<summary>Demo server privacy policy - Last updated December 26, 2019</summary>

Translators

• Basque - osoitz
• Catalan - xordiet
• Dutch - Jdekoning141
• French - thifranc and LukeMarlin
• German - natrius, hurradiegams, lemmerk, code-surfer and Marmo
• Italian - Vieler
• Norwegian Bokmål - bilde2910
• Norwegian Nynorsk - bilde2910
• Polish - krystiancha and RuralYak
• Portugese (Brazil) - arajooj
• Romanian - LicaonKter
• Russian - RuralYak, Brujerizmo90
• Spanish - sdstolworthy
• Turkish - kylethedeveloper, ayyilmaz
• Ukrainian - RuralYak

Translation status

Donate