Update documentation

This commit is contained in:
Bartek Fabiszewski 2019-02-22 20:22:27 +01:00
parent 1f6ecabf81
commit 0ce633a3bf
3 changed files with 8 additions and 7 deletions

View File

@ -4,6 +4,7 @@ LABEL maintainer="Bartek Fabiszewski (https://github.com/bfabiszewski)"
ARG DB_ROOT_PASS=secret1 ARG DB_ROOT_PASS=secret1
ARG DB_USER_PASS=secret2 ARG DB_USER_PASS=secret2
# supported drivers: mysql, pgsql, sqlite
ARG DB_DRIVER=mysql ARG DB_DRIVER=mysql
ENV ULOGGER_ADMIN_USER admin ENV ULOGGER_ADMIN_USER admin

View File

@ -18,8 +18,8 @@ Together with a dedicated [μlogger mobile client](https://github.com/bfabiszews
- altitudes graph - altitudes graph
- multiple users - multiple users
- user authentication - user authentication
- Google Maps API v3 - Google Maps
- OpenLayers v2 or v3 (OpenStreet and other layers) - OpenLayers (OpenStreet and other layers)
- ajax - ajax
- user preferences stored in cookies - user preferences stored in cookies
- simple admin menu - simple admin menu
@ -29,10 +29,10 @@ Together with a dedicated [μlogger mobile client](https://github.com/bfabiszews
## Install ## Install
- Download zipped archive or clone the repository on your computer - Download zipped archive or clone the repository on your computer
- Move it to your web server directory (unzip if needed) - 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 database and database 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 - 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` - 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 - Make sure you have a web server running with PHP and chosen database
- Open http://YOUR_HOST/ulogger-server/scripts/setup.php page in your browser - 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 - 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** - **Remember to remove or disable `scripts/setup.php` script**

View File

@ -40,7 +40,7 @@ $init_longitude = 21.01;
// you may set your google maps api key // you may set your google maps api key
$gkey = ""; $gkey = "";
// MySQL config // Database config
$dbdsn = ""; // DSN eg. "mysql:host=localhost;port=3307;dbname=testdb;charset=utf8" $dbdsn = ""; // DSN eg. "mysql:host=localhost;port=3307;dbname=testdb;charset=utf8"
$dbuser = ""; // database user $dbuser = ""; // database user
$dbpass = ""; // database pass $dbpass = ""; // database pass
@ -76,7 +76,7 @@ $pass_strength = 2;
$interval = 10; $interval = 10;
// Default language // Default language
// (en, pl, de, hu) // (en, pl, de, hu, fr, it)
$lang = "en"; $lang = "en";
//$lang = "pl"; //$lang = "pl";
//$lang = "de"; //$lang = "de";
@ -90,7 +90,7 @@ $units = "metric";
//$units = "imperial"; //$units = "imperial";
//$units = "nautical"; //$units = "nautical";
// These need to be copied to config.php // track line stroke
$strokeWeight = 2; $strokeWeight = 2;
$strokeColor = '#FF0000'; $strokeColor = '#FF0000';
$strokeOpacity = 1.0; $strokeOpacity = 1.0;