Adds plausible.
This commit is contained in:
49
plausible/versions/3/README.md
Normal file
49
plausible/versions/3/README.md
Normal file
@@ -0,0 +1,49 @@
|
||||
# Plausible Analytics
|
||||
|
||||
Plausible is a lightweight, privacy-friendly web analytics tool. It gives you a clear picture of how people find and use your websites — without tracking personal data, setting cookies, or requiring cookie consent banners. All data is stored on your own infrastructure.
|
||||
|
||||
It's a straightforward alternative to Google Analytics for organizations that care about visitor privacy and data sovereignty.
|
||||
|
||||
## Dependencies
|
||||
|
||||
- **PostgreSQL** - Database for storing sites, users, and configuration
|
||||
- **ClickHouse** - Bundled analytics event database (deployed automatically within the Plausible namespace)
|
||||
|
||||
## Configuration
|
||||
|
||||
Key settings configured through your instance's `config.yaml`:
|
||||
|
||||
- **domain** - Where Plausible will be accessible (default: `plausible.{your-cloud-domain}`)
|
||||
- **plausibleStorage** - Persistent volume for Plausible app data (default: `1Gi`)
|
||||
- **clickhouseStorage** - Persistent volume for analytics event data (default: `10Gi`). Increase this if you expect high traffic volumes.
|
||||
- **disableRegistration** - Controls who can create accounts: `"false"` (open), `"invite_only"`, or `"true"` (default: `"false"`)
|
||||
|
||||
## Access
|
||||
|
||||
After deployment, Plausible will be available at:
|
||||
- `https://plausible.{your-cloud-domain}` — Dashboard and admin
|
||||
|
||||
## First-Time Setup
|
||||
|
||||
1. Add and deploy the app:
|
||||
```bash
|
||||
wild app add plausible
|
||||
wild app deploy plausible
|
||||
```
|
||||
|
||||
2. Open `https://plausible.{your-cloud-domain}` and register an account. The first registered user becomes the admin.
|
||||
|
||||
3. Once your account is created, set `disableRegistration: "invite_only"` in your `config.yaml` to prevent open registration, then redeploy:
|
||||
```bash
|
||||
wild app deploy plausible
|
||||
```
|
||||
|
||||
4. Add a website in the Plausible dashboard and copy the tracking snippet into your site's `<head>`:
|
||||
```html
|
||||
<script defer data-domain="yourdomain.com"
|
||||
src="https://plausible.{your-cloud-domain}/js/script.js"></script>
|
||||
```
|
||||
|
||||
## Inviting Users
|
||||
|
||||
With registration set to `invite_only`, you can invite teammates from **Settings → Users** in the Plausible dashboard.
|
||||
Reference in New Issue
Block a user