Skip to content

Commit

Permalink
Added info about the project
Browse files Browse the repository at this point in the history
  • Loading branch information
berrnd committed Dec 30, 2016
1 parent 8a30e0b commit b404249
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 1 deletion.
31 changes: 30 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,34 @@
# LOCH
A private/selfhosted location history solution

## Motivation
I love to have a location history, but because such data is too private to let this do others for you, I searched for a self hosted solution, found nothing that fitted my needs completely, so this is LOCH.

Currently work in progress, more info when it's usable...
## How to install
Just unpack the [latest release](https://github.com/berrnd/LOCH/releases/latest) on your PHP enabled webserver, copy `config-dist.php` to `config.php`, edit it to your needs, create a MySQL database based on [db.sql](db.sql) and you're ready to go.
Alternatively clone this repository and install composer dependencies manually.

## What currently is possible
- It provides an API to save location data
- It gives you a simple web interface to show your location history in custom time ranges, calculates the (linear) distance, and so on

### Get data in
Make a POST to `https://LOCH/api/add/csv`, the body has to be one or multiple lines in the format `<parseable timestamp (ISO is good)>,<latitude>,<longitude>,<accuracy (integer, in meters)>`.
I personally do this with [Automagic](https://play.google.com/store/apps/details?id=ch.gridvision.ppam.androidautomagic) on my smartphone.

### Calculate distance between location points
This can be a long running task, so this is not done at the time of import - just setup a cron job for example every hour.

`*/60 * * * * www-data php /<LOCH>/index.php /cli/calculate/distance GET`

### Show your location history
Just browse to the your install URL and login with the configured credentials

## Screenshots
![Main page](https://github.com/berrnd/LOCH/raw/master/screenshots/mainpage.png "Main page")

## Todo
The analysis features are very basic for now, there are much more great things, heatmaps, "where spent I most of my time", and so on...

## License
The MIT License (MIT)
Binary file added screenshots/mainpage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b404249

Please sign in to comment.