diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 8 |
1 files changed, 5 insertions, 3 deletions
@@ -22,7 +22,7 @@ $ pip3 install -r requirements.txt This software requires an empty MySQL Database. When this is created import the database structure from `db_structure.sql`. ### Configuration -Create a config file for the database importer in `import/configuration.ini` as follows +Create a config file for the database importer in `import/config.ini` as follows ```ini [db] host=mysqlhost @@ -31,7 +31,7 @@ password=mysqlpassword name=mysqldbname ``` -Do the same for the dashboard in `dash/configuration.ini`, the config file has the exact same structure. +Do the same for the dashboard in `dash/config.ini`, the config file has the exact same structure. --- **Note**: For improved security, the importer should have a db user with full privileges whereas the dashboard only requires read access. @@ -43,7 +43,7 @@ However, if both of them are on the same machine and running with the same user ## Usage ### Importer -The import script can import one statistic file at once. It is called as follows: +The import script can import one statistic file at once. It must be run with its folder as working directory. It is called as follows: ```bash $ python3 import.py report_file.json ``` @@ -51,6 +51,8 @@ Be sure to either activate the venv before running this command as seen above or In a real world application one would write a shell script which calls the importer for every file in a directory. The importer will know if a report was previously imported and not import it again. Therefore, the script could run every week on all reports from the current year and the last year, but more advanced logic here would be possible. +There is also a sample script `import-batch.sh` which can be run with one folder as argument. The working diretory must also be the directory of the script. + ### Dashboard The dashboard can be run using systemd with the following unit file: ```ini |