commit 62b9936eda066ae8f669630468b545fc6f9195e8 Author: Marius Lindvall Date: Fri Sep 13 16:37:00 2019 +0200 Add initial FAQ diff --git a/FAQ.md b/FAQ.md new file mode 100644 index 0000000..1b530ed --- /dev/null +++ b/FAQ.md @@ -0,0 +1,63 @@ +# Installation + +### How do I install Hauk? + +Please [refer to the README](https://github.com/bilde2910/Hauk#installation-instructions). + +### Can I reverse proxy the Hauk Docker container? + +Yes, and you should, for security reasons. There is an [example config for nginx](https://github.com/bilde2910/Hauk#via-docker-compose) in the README. Avoid exposing Hauk on port 80 directly for privacy and security reasons. + +### What if I want to expose port 80? + +That's up to you, but I strongly recommend against it. The traffic would be passed unencrypted, meaning others in your network can sniff on your location, get your password, and more. + +### But won't that also happen if I allow traffic to port 80 in the proxy? + +Yes. You should ideally only allow traffic to port 443 with HTTPS. If clients connect with plain-text HTTP on port 80, the proxy should be set up to redirect them to HTTPS. + +# Common issues + +### Why does my shared location link point to "example.com"? + +You forgot to set the `public_url` setting in the config file. + +# Privacy + +### Who can see my location data? + +Anyone with the sharing link. The link is 8 randomly generated letters and numbers by default. + +### What if I use a public instance? + +You are encouraged not to use any public instances except for demonstration purposes. If you connect the app to a public instance, nothing prevents its administrator from logging your location with no transparency or external oversight. + +### How long does my share last? + +Until it expires, or until you stop it. + +### Where is the location data saved? + +Hauk does not save your location to disk; it is kept only in memory. Hauk uses Memcached to store its data. If you restart Memcached, the data is lost. + +### Is my data sent to any third parties? + +No. It can only be seen by people you share the link with. + +### Does the app have any kind of analytics or telemetry? + +No. The only connections the app make are to the Hauk server you specify. + +### Why does the app need the permissions it requests? + +The app requests these permissions: + +* `ACCESS_FINE_LOCATION` - for getting your location, so that it can be shared +* `FOREGROUND_SERVICE` - for keeping the share running when the app is minimized +* `INTERNET` - for communicating with your Hauk backend server + +# Security + +### How do I prevent strangers from starting sharing sessions on my server? + +Set a password in the configuration file. An explanation of how is provided in the config file itself. \ No newline at end of file