From df0e3b86e26a3eafb5acc67932c609743e70805e Mon Sep 17 00:00:00 2001 From: moanos Date: Wed, 8 Nov 2023 13:45:46 +0100 Subject: [PATCH] docs(oxitraffic): Add docs --- docs/services/oxitraffic.md | 38 +++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 docs/services/oxitraffic.md diff --git a/docs/services/oxitraffic.md b/docs/services/oxitraffic.md new file mode 100644 index 0000000..103e8e4 --- /dev/null +++ b/docs/services/oxitraffic.md @@ -0,0 +1,38 @@ +# OxiTraffic + +[OxiTraffic](https://codeberg.org/mo8it/oxitraffic) is a self-hosted, simple and privacy respecting website traffic tracker, that this playbook can install, powered by the [mother-of-all-self-hosting/ansible-role-oxitraffic](https://github.com/mother-of-all-self-hosting/ansible-role-oxitraffic) Ansible role. + +## Dependencies + +This service requires the following other services: + +- a [Postgres](postgres.md) database +- a [Traefik](traefik.md) reverse-proxy server + + +## Configuration + +To enable this service, add the following configuration to your `vars.yml` file and re-run the [installation](../installing.md) process: + +```yaml +######################################################################## +# # +# oxitraffic # +# # +######################################################################## + +oxitraffic_enabled: true +oxitraffic_hostname: traffic.example.org +oxitraffic_tracked_origin: https://example.org + +######################################################################## +# # +# /oxitraffic # +# # +######################################################################## +``` + +You must include the counting script on the `oxitraffic_tracked_origin` by adding the following to you website +```html + +``` \ No newline at end of file