docs(oxitraffic): Add docs
This commit is contained in:
parent
db705d7dba
commit
df0e3b86e2
1 changed files with 38 additions and 0 deletions
38
docs/services/oxitraffic.md
Normal file
38
docs/services/oxitraffic.md
Normal file
|
@ -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
|
||||||
|
<script type="module" src="https://YOUR-OXITRAFFIC_HOSTNAME/count.js"></script>
|
||||||
|
```
|
Loading…
Reference in a new issue