mbirth/php-owntracks-recorder
Archived
1
0
Fork 0
Code Issues 1 Pull Requests Activity

README fixes.

Browse Source
This commit is contained in:
Markus Birth
2018-04-27 02:02:28 +02:00
parent 81781cf16b
commit 3660bc1fb3
1 changed files with 32 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
README.md
View File

@ -18,7 +18,7 @@ Features
* Owntracks HTTP payloads recoding into database
* Interface to map location records
* Responsive : accessible on mobile and tablet!
* Responsive: accessible on mobile and tablet!
* Calendar to select location records period
@ -35,8 +35,8 @@ That's it !
### Installation instructions
#### PHP Client
1. Download the source code and copy the content of the directory to your prefered location
2. Edit the `config.inc.sample.php` file to setup access to your database and rename to `config.inc.php` :
```php
2. Edit the `config.inc.sample.php` file to setup access to your database and rename to `config.inc.php`:
```php
$_config['sql_type'] // database type 'mysql' (MySQL/MariaDB) or 'sqlite'
$_config['sql_host'] // sql server hostname (only needed for 'mysql')
$_config['sql_user'] // sql server username (only needed for 'mysql')
@ -44,47 +44,47 @@ That's it !
$_config['sql_db'] // database name or SQLite filename
$_config['sql_prefix'] // table prefix (only needed for 'mysql')
$_config['default_accuracy'] // default maxymum accuracy for location record to be displayed on the map
$_config['default_accuracy'] // default maximum accuracy for location record to be displayed on the map
$_config['enable_geo_reverse'] // set to TRUE to enable geo decoding of location records
$_config['geo_reverse_lookup_url'] // geodecoding api url, will be appended with lat= & lon= attributes
```
```
3. Create datatable using schema_mysql.sql or schema_sqlite.sql (in the 'sql' directory)
4. Make sure you have installed [bower](https://bower.io/) (via [npm](https://nodejs.org/)):
```
sudo -H npm install -g bower
```
```
sudo -H npm install -g bower
```
If you don't have access to the root user, you can install it locally:
```
npm install -g --prefix=$HOME bower
export PATH=$HOME/bin:$PATH
```
```
npm install -g --prefix=$HOME bower
export PATH=$HOME/bin:$PATH
```
5. Get [Composer](https://getcomposer.org/download/) and install dependencies (this will call `bower` automatically):
```
./composer.phar install
```
```
./composer.phar install
```
#### Owntracks app
Follow [Owntracks Booklet](http://owntracks.org/booklet/features/settings/) to setup your Owntracks app :
Follow [Owntracks Booklet](http://owntracks.org/booklet/features/settings/) to setup your Owntracks app:
1. Setup your Owntracks app :
1. Mode : HTTP
2. URL : http://your_host/your_dir/record.php
1. Setup your Owntracks app:
1. Mode: HTTP
2. URL: http://your_host/your_dir/record.php
Usage
-----
### First time access
Access map of today's recorded locations at : http://your_host/your_dir/
Access map of today's recorded locations at: http://your_host/your_dir/
### Navigate through your recorded locations
* Use the "Previous" and "Next" buttons
* Manually change the From / To dates (next to the "Previous" button)
### Adjust map settings
* Use the "Config" button to :
* Use the "Config" button to:
* Display or hide the individual markers (first and last markers for the period will always be displayed)
* Change maximum accuracy for displayed location records
@ -92,9 +92,7 @@ Access map of today's recorded locations at : http://your_host/your_dir/
Contributing
------------
So far my team is small - just 1 person, but I'm willing to work with you!
I'd really like for you to bring a few more people along to join in.
Pull Requests and feature requests are welcomed.
License