ulogger-server/README.md

51 lines
2.4 KiB
Markdown
Raw Normal View History

2017-04-13 10:25:04 +02:00
# ![ulogger_logo_small](https://cloud.githubusercontent.com/assets/3366666/24080878/0288f046-0ca8-11e7-9ffd-753e5c417756.png)μlogger
2017-03-16 12:46:22 +01:00
2017-04-10 22:46:56 +02:00
This is a web application for real-time collection of geolocation data, tracks viewing and management.
2017-03-16 12:46:22 +01:00
Together with a dedicated [μlogger mobile client](https://github.com/bfabiszewski/ulogger-android) it may be used as a complete self hosted serverclient solution for logging and monitoring users' geolocation.
2013-06-19 13:27:14 +02:00
2017-03-16 12:46:22 +01:00
## Live demo:
2017-05-19 16:48:15 +02:00
- http://ulogger.fabiszewski.net/ (test track upload and editing, login: demo, password: demo)
2013-06-19 13:27:14 +02:00
2017-03-16 12:46:22 +01:00
## Requirements:
2017-04-17 13:15:44 +02:00
- PHP 5.5 (5.4 with [password_compat](https://github.com/bfabiszewski/ulogger-server/blob/04b2b771398d8511bfa6fe8a85d58162bd32fc46/helpers/user.php#L24))
2017-04-10 22:46:56 +02:00
- MySQL 4.1
2013-06-23 23:53:19 +02:00
- browser with javascript enabled, cookies for authentication and saving preferences
2013-06-19 13:27:14 +02:00
2017-03-16 12:46:22 +01:00
## Features:
2013-06-19 13:27:14 +02:00
- simple
- allows live tracking
- track statistics
- altitudes graph
- multiple users
- user authentication
- Google Maps API v3
2017-01-30 21:36:44 +01:00
- OpenLayers v2 (OpenStreet and other layers)
2017-04-10 22:46:56 +02:00
- ajax
2013-06-23 23:53:19 +02:00
- user preferences stored in cookies
2017-03-16 12:46:22 +01:00
- simple admin menu
2017-05-10 14:59:52 +02:00
- export tracks to gpx and kml
- import tracks from gpx
2013-06-19 13:27:14 +02:00
2017-04-04 17:03:58 +02:00
## Install
2017-04-17 13:15:44 +02:00
- Download zipped archive or clone the repository on your computer
- Move it to your web server directory (unzip if needed)
- Create database and MySQL user (at least SELECT, INSERT, UPDATE, DELETE privileges, CREATE, DROP for setup script)
- Create a copy of `config.default.php` and rename it to `config.php`. Customize it and add database credentials
- Edit `scripts/setup.php` script, enable it by setting [$enabled](https://github.com/bfabiszewski/ulogger-server/blob/master/scripts/setup.php#L21) value to `true`
- Make sure you have a web server running with PHP and MySQL
- Open http://YOUR_HOST/ulogger-server/scripts/setup.php page in your browser
- Follow instructions in setup script. It will add database tables and set up your μlogger user
- **Remember to remove or disable `scripts/setup.php` script**
- Log in with your new user on http://YOUR_HOST/ulogger-server/
- You may also want to set your new user as an [admin in config file](https://github.com/bfabiszewski/ulogger-server/blob/v0.2/config.default.php#L67).
2017-04-04 17:03:58 +02:00
2017-03-16 12:46:22 +01:00
## Todo
2017-04-17 13:15:44 +02:00
- improve track editing
- track display filters (accurracy, provider)
2017-05-10 14:59:52 +02:00
- improve interface on mobile devices
2013-06-19 13:27:14 +02:00
2017-03-16 12:46:22 +01:00
## License
2013-06-19 13:27:14 +02:00
- GPL
2017-04-04 17:03:58 +02:00
- μlogger is a fork of phpTrackme - tracks viewer I wrote for TrackMe app
2017-04-10 22:46:56 +02:00
- most icons come from [iconmonstr](https://iconmonstr.com)