> ## Documentation Index
> Fetch the complete documentation index at: https://docs.suji.fr/llms.txt
> Use this file to discover all available pages before exploring further.

# Plausible

> Self-hosted, privacy-friendly web analytics. Install, create your account, and add your first site.

[Plausible](https://plausible.io) is open-source, privacy-friendly web analytics — a lightweight, cookie-free alternative to Google Analytics. You manage it from its web UI at your `*.suji.fr` address and embed a small script on the sites you track.

This page covers running Plausible on Suji end-to-end. Plausible is maintained upstream; Suji provides the [marketplace packaging](https://github.com/suji-hq/suji-templates/tree/main/plausible).

***

## Before you install

Plausible needs one thing you generate yourself: a **secret key** of at least 64 characters. Create one with:

```bash theme={"dark"}
openssl rand -base64 64
```

Keep it handy for the install form. Everything else (its PostgreSQL and ClickHouse databases) is bundled — you don't manage them.

<Note>
  The first person to open the URL creates the owner account. Set yours up immediately after install.
</Note>

***

## Install

Dashboard → **Apps** → **Plausible** → **Install**:

| Field             | Required | Notes                                                                                                           |
| ----------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
| VM                | yes      | Plausible runs three services (app + PostgreSQL + ClickHouse) — needs \~3 GB.                                   |
| Subdomain         | no       | Suggestion is `plausible`. Reached at `https://<subdomain>.suji.fr`, which Plausible auto-uses as its base URL. |
| Secret key base   | yes      | The 64+ char secret you generated above (`openssl rand -base64 64`).                                            |
| Database password | no       | For the bundled PostgreSQL. Auto-generated if left blank.                                                       |

Recommended VM size: **Medium or larger** — Plausible bundles its own PostgreSQL and ClickHouse, so it's heavier than a single-container app. See [Recommended size](#recommended-size).

Click **Deploy**. First boot runs database migrations, so it takes a little longer than a single-container app. When it's `running`, it's live at `https://plausible-<random>.suji.fr` over HTTPS through the tunnel.

***

## First connection — create your account

1. Open the install URL (`https://plausible-<random>.suji.fr`).
2. You're redirected to **`/register`** — create your account (email + password).
3. Add your first site (the domain you want to track) and copy the tracking snippet.
4. Paste the snippet into that site's `<head>`. Stats start flowing in.

<Warning>
  Registration is open the moment the install is `running`. Claim the owner account right after deploy. (To lock registration down afterwards, see Plausible's self-host settings.)
</Warning>

***

## Email & reports

Plausible sends email for account invites, password resets, and scheduled email reports — but **no mail provider is configured by default**, so those won't send until you add SMTP. Note the network blocks outbound SMTP on ports 25 and 465; use port 587 or an HTTP-based provider. Add the SMTP env vars to the install yourself via **Edit Install → environment variables**, then redeploy.

***

## Using an external database

By default Plausible runs its **own bundled PostgreSQL and ClickHouse** — nothing to manage. If you need to point at external database servers instead (advanced), use the compose-edit escape hatch: set `DATABASE_URL` and `CLICKHOUSE_DATABASE_URL` to your servers and drop the bundled services.

***

## Day-to-day management

| Want to…                          | Where                                                          |
| --------------------------------- | -------------------------------------------------------------- |
| View analytics / manage sites     | The Plausible dashboard (`https://plausible-<random>.suji.fr`) |
| Invite team members               | Dashboard → site settings (needs email configured)             |
| View container logs               | Dashboard → Logs (pick Plausible)                              |
| Open a shell inside the container | Dashboard → Terminal (pick Plausible)                          |
| Restart the app                   | Install detail page → Restart                                  |
| Upgrade to a newer version        | Install detail page → Upgrade (when available)                 |
| Remove the install + its data     | Install detail page → Uninstall                                |

***

## Troubleshooting

<AccordionGroup>
  <Accordion title="Install takes a while / first load is slow">
    First boot runs PostgreSQL and ClickHouse migrations before the app serves — that's normal and only happens once. Give it a minute after `running`.
  </Accordion>

  <Accordion title="'SECRET_KEY_BASE' / secret too short error">
    The secret must be at least 64 characters. Regenerate with `openssl rand -base64 64` and update the install.
  </Accordion>

  <Accordion title="Invite / report emails aren't sending">
    Expected until you configure SMTP — see Email & reports above (use port 587; 25/465 are blocked upstream).
  </Accordion>

  <Accordion title="Bad gateway (Cloudflare 502)">
    Plausible isn't reachable through the tunnel yet — usually still migrating/starting (wait \~30–60 s). If it persists, the Logs tab shows why the container isn't up.
  </Accordion>
</AccordionGroup>

***

## Where things live

| What                            | Service               | Named volume            |
| ------------------------------- | --------------------- | ----------------------- |
| Site config, users (PostgreSQL) | `plausible_db`        | `plausible-db-data`     |
| Analytics events (ClickHouse)   | `plausible_events_db` | `plausible-events-data` |

Uninstalling deletes both volumes by default — that's all your analytics history. Choose **keep data** during uninstall to preserve it.

***

## Recommended size

* **Medium or larger.** Plausible runs three services (app + PostgreSQL + ClickHouse) and needs roughly 3 GB total; ClickHouse in particular is memory-hungry.
* Memory/disk grow with traffic volume and history retention.
* If you run other apps on the same VM, factor in that the VM's total CPU/memory is shared — Plausible is one of the heavier marketplace apps.

***

## Reporting issues

| Class                                                         | Where                                                                             |
| ------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| Plausible bug (dashboard, tracking, analytics)                | [plausible/analytics issues](https://github.com/plausible/analytics/issues)       |
| Marketplace packaging bug (compose / manifest / install form) | [suji-hq/suji-templates issues](https://github.com/suji-hq/suji-templates/issues) |
| Suji platform bug (dashboard, billing, network)               | Support ticket from the dashboard                                                 |
