Merge pull request #6 from biigle/patch-1

Polish

.github/workflows/test.yml

@@ -57,9 +57,9 @@ jobs:
         docker pull ghcr.io/biigle/worker:latest
 
     - name: Start test database
-      run: docker-compose up -d --no-build database_testing && sleep 5
+      run: docker compose up -d --no-build database_testing && sleep 5
       working-directory: ../core
 
     - name: Run tests
-      run: docker-compose run --rm -u 1001 worker php -d memory_limit=1G vendor/bin/phpunit --random-order --filter 'Biigle\\Tests\\Modules\\'${MODULE_NAME}
+      run: docker compose run --rm -u 1001 worker php -d memory_limit=1G vendor/bin/phpunit --random-order --filter 'Biigle\\Tests\\Modules\\'${MODULE_NAME}
       working-directory: ../core

README.md

@@ -7,7 +7,12 @@ A BIIGLE module to collect key performance indicators.
 ## Installation
 
 1. Run `composer require biigle/kpis`.
-2. Run `php artisan vendor:publish --tag=public` to refresh the public assets of the modules. Do this for every update of this module.
+2. Add the `KPIS_TOKEN` variable to the `.env` file. The value is an authentication token (e.g. generated with `pwgen 30 1`).
+3. Copy the [Bash script](src/resources/scripts/countRequests.sh) to your webserver, configure the authentication token (and maybe the base URL) inside the script and set up a daily cron job that executes the script with the gzipped webserver logfile of the previous day as argument. Example:
+   ```
+   30 0 * * * /path/to/countRequests.sh /path/to/logfiles/$(/bin/date -Idate --date "1 day ago").sql.gz > /path/to/countRequests.log 2>&1
+   ```
+4. Run the migrations.
 
 ## Developing