@@ -23,7 +23,11 @@ The output of the command will return the instance name.
2323Example output:
2424
2525``` json
26- {"module_id" : " matomo1" , "image_name" : " matomo" , "image_url" : " ghcr.io/geniusdynamics/matomo:latest" }
26+ {
27+ "module_id" : " matomo1" ,
28+ "image_name" : " matomo" ,
29+ "image_url" : " ghcr.io/geniusdynamics/matomo:latest"
30+ }
2731```
2832
2933## Configure
@@ -32,35 +36,35 @@ Assuming the Matomo instance is named `matomo1`, launch `configure-module` with
3236
3337### MariaDB Service Configuration
3438
35- | Parameter | Value |
36- | -----------| -------|
37- | ` MYSQL_ROOT_PASSWORD ` | Set a strong password for root user |
38- | ` MARIADB_AUTO_UPGRADE ` | 1 |
39- | ` MARIADB_DISABLE_UPGRADE_BACKUP ` | 1 |
39+ | Parameter | Value |
40+ | -------------------------------- | ----------------------------------- |
41+ | ` MYSQL_ROOT_PASSWORD ` | Set a strong password for root user |
42+ | ` MARIADB_AUTO_UPGRADE ` | 1 |
43+ | ` MARIADB_DISABLE_UPGRADE_BACKUP ` | 1 |
4044
4145### Database Configuration
4246
43- | Parameter | Description |
44- | -----------| -------------|
45- | ` MYSQL_PASSWORD ` | Password for the Matomo database user |
46- | ` MYSQL_DATABASE ` | Name of the Matomo database |
47- | ` MYSQL_USER ` | Username for the Matomo database |
48- | ` MATOMO_DATABASE_ADAPTER ` | mysql |
49- | ` MATOMO_DATABASE_TABLES_PREFIX ` | Table prefix (optional) |
50- | ` MATOMO_DATABASE_USERNAME ` | Database username |
51- | ` MATOMO_DATABASE_PASSWORD ` | Database password |
52- | ` MATOMO_DATABASE_DBNAME ` | Database name |
53- | ` MARIADB_INITDB_SKIP_TZINFO ` | 1 |
47+ | Parameter | Description |
48+ | ------------------------------- | ------------------------------------- |
49+ | ` MYSQL_PASSWORD ` | Password for the Matomo database user |
50+ | ` MYSQL_DATABASE ` | Name of the Matomo database |
51+ | ` MYSQL_USER ` | Username for the Matomo database |
52+ | ` MATOMO_DATABASE_ADAPTER ` | mysql |
53+ | ` MATOMO_DATABASE_TABLES_PREFIX ` | Table prefix (optional) |
54+ | ` MATOMO_DATABASE_USERNAME ` | Database username |
55+ | ` MATOMO_DATABASE_PASSWORD ` | Database password |
56+ | ` MATOMO_DATABASE_DBNAME ` | Database name |
57+ | ` MARIADB_INITDB_SKIP_TZINFO ` | 1 |
5458
5559### Matomo Environment Configuration
5660
57- | Parameter | Description |
58- | -----------| -------------|
59- | ` MATOMO_DATABASE_HOST ` | Database host (e.g., MariaDB module) |
60- | ` PHP_MEMORY_LIMIT ` | PHP memory limit (e.g., 2048M) |
61- | ` host ` | Fully qualified domain name for Matomo |
62- | ` http2https ` | Enable or disable HTTP to HTTPS redirection |
63- | ` lets_encrypt ` | Enable or disable Let's Encrypt certificate |
61+ | Parameter | Description |
62+ | ---------------------- | ------------------------------------------- |
63+ | ` MATOMO_DATABASE_HOST ` | Database host (e.g., MariaDB module) |
64+ | ` PHP_MEMORY_LIMIT ` | PHP memory limit (e.g., 2048M) |
65+ | ` host ` | Fully qualified domain name for Matomo |
66+ | ` http2https ` | Enable or disable HTTP to HTTPS redirection |
67+ | ` lets_encrypt ` | Enable or disable Let's Encrypt certificate |
6468
6569Example:
6670
@@ -86,6 +90,14 @@ See also the `systemd/user/matomo.service` file.
8690
8791This setting discovery is just an example to understand how the module is expected to work: it can be rewritten or discarded completely.
8892
93+ ## Update
94+
95+ You can forcefully update the module
96+
97+ ``` bash
98+ api-cli run update-module --data ' {"module_url":"ghcr.io/geniusdynamics/matomo:latest","instances":["matomo1"],"force":true}'
99+ ```
100+
89101## Uninstall
90102
91103To uninstall the instance:
@@ -111,4 +123,5 @@ Translated with [Weblate](https://hosted.weblate.org/projects/ns8/).
111123To setup the translation process:
112124
1131251 . Add [ GitHub Weblate app] ( https://docs.weblate.org/en/latest/admin/continuous.html#github-setup ) to your repository
114- 2 . Add your repository to [ hosted.weblate.org] ( https://hosted.weblate.org ) or ask a NethServer developer to add it to the NS8 Weblate project
126+ 2 . Add your repository to [ hosted.weblate.org] ( https://hosted.weblate.org ) or ask a NethServer developer to add it to the NS8 Weblate project
127+
0 commit comments