README/docs: General documentation improving

Author: robske110

README.md

@@ -14,22 +14,26 @@ It includes an iOS widget (using Scriptable) and a webpage for seeing current st
 ### Setup for beginners
 
 A quick heads-up beforehand: Setting this up for someone who has never set up a webserver before can be challenging.
-Don't worry though, the [beginners guide](docs/beginnerguide.md) tries to help you as much as possible and guides you through every step.
+Don't worry though, the [beginners guide](docs/beginnerguide.md) guides you through every step you need to take.
+Should you have any remaining questions or issues please see [getting help](https://github.com/robske110/IDDataLogger/wiki/Getting-help).
 
 ### Setup for advanced users
 
-Prerequisites are:
+#### Prerequisites
+
 - PHP 8 cli with pgsql (or mysql), curl, gd and dom
 - A webserver serving .php files (PHP 8 with pgsql (or mysql))
 - (strongly recommended) HTTPS enabled server with certificate
-- A postgresql server (Any version from 9 and up should work, although testing has only been done on 11 and up)
-    - alternatively mysql / mariadb is supported (alternative db servers may also work)
+- A PostgreSQL server (Any version from 9 and up should work, although testing has only been done on 11 and up)
+    - alternatively MySQL / MariaDB is supported, but PostgreSQL is recommended.
 
-Clone this project.
+#### Overview of the setup process
 
+Clone this repository.
+   
 `git clone https://github.com/robske110/IDDataLogger.git --recursive`
 
-Create a database (and a user) in your postgresql (or other) server for this project and fill in the details into `config/config.example.json` and `.env.example.` We'll need these files later.
+Create a database (and a user) in your PostgreSQL (or other) server for this project and fill in the details into `config/config.example.json` and `.env.example.` We'll need these files later.
 You can do this using the config setup wizard by running the `config-wizard.sh` script, or manually.
 Note: for a detailed description of the possible config values visit [config.md](docs/config.md).
 
@@ -53,11 +57,15 @@ After successful start you can now visit idView.php or use the iOS widget after
 
 ## Contributing
 
-Contributions are always welcome! You can help to improve the documentation, fix bugs in the code or even add new features.
+Contributions are always welcome! You can help to improve the documentation, fix bugs in the code or add new features.
 
 Creating a containerized version (for example docker and especially with letsencrypt/certbot support) or
 improving the beginners guide are currently something I would love to have help with. Feel free to open a PR!
 
+### A big 'Thank you!' to the following contributors
+
+- @drego83 - Invaluable help with general testing and MySQL support
+
 ## Disclaimer
 
 This project is not endorsed by Volkswagen in any way, shape or form. This project is to be used entirely at your own risk.

docs/beginnerguide.md

@@ -1,56 +1,57 @@
 # Setup Guide for beginners
 Hi! You want to use this project, but have little to no experience setting up servers?
-Please free up a few hours for setting this project up.
+Please free up about an hour for setting this project up.
 
-Setting this project up is recommended on a raspberrypi for beginners. This guide assumes you are running on a raspberrypi.
-If you do not have a raspberrypi handy, any Debian installation will also work with the easy install scripts and this guide.
+Setting this project up is recommended on a Raspberry Pi for beginners. This guide assumes you are running raspbian.
+If you do not have a Raspberry Pi handy, any Debian installation will also work with the easy install scripts and this guide.
 
 Before we begin, let's go through what this project needs and does from a technical overview standpoint:
 
 This project contains a long-running program which will fetch data from VW APIs regarding your car and store this data in a database.
 It also provides a website where you can view this data. Furthermore, it provides an API itself to quickly fetch the current car Status for displaying in, e.g. the iOS widget.
 
-So we have three components: The long-running programm, the database and a webserver to serve you the stats website or the data for the iOS widget.
-All of this can run on a raspberrypi.
+So we have three components: The long-running programm, the database and a webserver to serve you the statistics website or the data for the iOS widget.
+All of this can run on a Raspberry Pi.
 
 Let's get to work then.
 
 ## Prerequisites
 You'll need
-- a raspberrypi with an internet connection and raspbian installed (alternatively any machine with a debian installation works)
+- a Raspberry Pi with an internet connection and raspbian installed (alternatively any machine with a debian installation works)
 - a publicly routable IPv4 address if you want to use the widget and website from outside your home network (Some fibre plans for example do not include this)
 
-We assume you have your raspberrypi freshly setup and have the command prompt in front of you.
+We assume you have your Raspberry Pi freshly setup and have the command prompt in front of you.
 There are plenty of guides on the internet on how to archive this.
 
-You should see the following line: `pi@raspberrypi:~ $`
+You should see the following line: `pi@Raspberry Pi:~ $`
 
-We strongly recommend changing your password on the raspberrypi to a reasonably strong one.
+We strongly recommend changing your password on the Raspberry Pi to a reasonably strong one.
 
 Now you'll need to decide how you want to setup this project.
 There is a one-line command which attempts to install this project automagically, but if you prefer to do some things manually and learn some things in the process jump to this [section](#installing-manually).
 
 ## Installing using the install script
 
 The install script works and is tested on raspbian and debian.
-It assumes you have a fresh OS, especially without any existing postgres or webserver installations.
+It assumes you have a fresh OS, especially without any existing PostgreSQL or webserver installations.
 
 Enter (or copy) the following command to download and run the install script:
 
 `wget https://raw.githubusercontent.com/robske110/IDDataLogger/master/docs/install.sh; bash install.sh; rm install.sh`
 
 The install script will produce a lot of output. After a few minutes you will be prompted for your VW account login information.
 After you enter the information you should see `Installation complete, ...`.
-You can now enter `./start.sh`, which will start the ID DataLogger and help you create an API key for your widget and a user for the web interface.
+
+You can now enter `cd ./IDDatalogger` followed by `./start.sh`, which will start the ID DataLogger and help you create an API key for your widget and a user for the web interface.
 For more information on setting up the iOS widget using the API key see [Setting up the iOS Widget](ioswidget.md).
 
 After creating the API key and the user you should see `Done. Ready! Fetching car status...` and `Writing new data for timestamp`.
 This means you have successfully setup the ID DataLogger!
-Please shutdown the ID DataLogger using the key combination CTRL+C and reboot the raspberrypi using `systemctl reboot`
+Please shutdown the ID DataLogger using the key combination CTRL+C and reboot the Raspberry Pi using `systemctl reboot`.
 
-You can now access the ID DataLogger by entering `IP/vwid` into your browser where `IP` is the ip or hostname of your raspberry or using the iOS widget.
+You can now access the ID DataLogger by entering `http://IP/vwid` into your browser where `IP` is the ip address or hostname of your raspberry or using the iOS widget.
 
-To find the ip of your raspberrypi simply enter the command `hostname -I`
+To find the ip address of your Raspberry Pi simply enter the command `hostname -I`
 
 If you want to view the website and have the iOS widget update outside your home network, please refer to [making the ID DataLogger available from the internet](#making-the-id-datalogger-available-from-the-internet).
 
@@ -72,9 +73,11 @@ wget -q -O - https://packages.sury.org/php/README.txt | bash -s -
 sudo apt install php8.0
 ```
 The first command will install a repository which contains the latest version of PHP.
-The second command will install php 8 and setup the webserver apache2.
+The second command will install php 8 and install and setup the webserver apache2.
 The last command we'll need to execute is
+
 `sudo apt install postgresql`
+
 This will install the PostgreSQL database. It will store our information about the car.
 
 cd

docs/config.md

@@ -1,4 +1,7 @@
 # Config
+
+## config.json
+
 `username` The E-Mail Address used for your VW ID account
 
 `password` The password used for your VW ID account
@@ -18,6 +21,8 @@ Can be `null`, which causes the first vehicle to be used. (Recommended when you
 
 `db.password` The password for the database
 
+`db.driver` The driver for the database. See https://www.php.net/manual/en/pdo.drivers.php for possible values.
+
 `carpic.flip` Whether to flip the carpic (default: true)
 
 The keys
@@ -35,10 +40,27 @@ can have the following values:
 | front | left   |
 | front | right  |
 
-`timezone` Server timezone. This is used for correct timestamps in logs.
+Note: For changes to the carpic settings to apply, delete data/carPic.png
+
+`timezone` Server timezone. This is used for correct timestamps in logs. (Overrides settings in php.ini)
 
 `logging.debug-enable` Enables debug output
 
 `logging.file-enable` Enables debug output
 
-`logging.log-dir` The directory in which to store log files. Can be `null` for default directory. (`program_directory/log`)
+`logging.log-dir` The directory in which to store log files. Can be `null` for default directory (`program_directory/log`).
+
+## .env file
+
+`DB_HOST` The host of the postgres db server
+
+`DB_NAME` The name of the database that this application can use
+
+`DB_USER` The username for the database
+
+`DB_PASSWORD` The password for the database
+
+`DB_DRIVER` The driver for the database. See https://www.php.net/manual/en/pdo.drivers.php for possible values.
+
+`FORCE_ALLOW_HTTP` Set this option to true to force the login system to allow http access.
+It is strongly recommended to omit this option whenever possible, especially on installations accessible over the internet.