# Self-host Ackee

> A self-hosted, privacy-friendly web analytics tool that tracks page views without cookies or personal data. MIT licensed. Runs with a MongoDB service. The admin password is generated for you and shown in the deployment variables.

- Page: https://levelrail.com/templates/ackee/
- JSON: https://levelrail.com/templates/ackee.json
- Category: Analytics
- Licence: MIT (Permissive license)
- Source: https://github.com/electerious/Ackee
- Upstream docs: https://github.com/electerious/Ackee/blob/master/docs/Get%20started.md

## Requirements
- Memory: about 640 MiB
- amd64: published, arm64: published
- Needs configuration before start: no
- Pinned image tag: 3.7.1

## Services

| Service | Image | Tag | Ports | Volumes |
| --- | --- | --- | --- | --- |
| ackee | electerious/ackee | 3.7.1 | 3000 | none |
| mongo | mongo | 7.0.45 | none | mongo -> /data/db |

## Environment

| Service | Variable | Kind |
| --- | --- | --- |
| ackee | ACKEE_MONGODB | preset |
| ackee | ACKEE_PASSWORD | generated |
| ackee | ACKEE_TRACKER | preset |
| ackee | ACKEE_USERNAME | preset |

## Deploy

### CLI

```bash
levelrail-cli templates install ackee --name my-ackee
```

Add --domain SERVICE=HOST to serve a service on your own domain, for example --domain ackee=app.example.com.

### API

```bash
curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  https://levelrail.example.com/api/v1/service-templates/ackee/install \
  -d '{
    "name": "my-ackee"
  }'
```

Create a token in the dashboard first. Name, env and domains are the request fields.

## First run
1. Sign in with the admin username and the generated password, then add your site to get the tracking snippet.

## Questions

### Can I deploy Ackee on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list has an entry with the id ackee for this app, so check that entry as well. Dokku deploys container images with its own commands, so the pinned image electerious/ackee:3.7.1, mongo:7.0.45 is what you deploy there.

Self-host Ackee, Ackee docker compose file, deploy Ackee on a VPS: this page lists the pinned image, ports, volumes and the commands for each.
