2024-09-04 16:11:58 +07:00
# Plausible Community Edition
### Prerequisites
- **[Docker ](https://docs.docker.com/engine/install/ )** and ** [Docker Compose ](https://docs.docker.com/compose/install/ )** must be installed on your machine.
2024-09-04 16:32:07 +07:00
- **CPU:** Must support **SSE 4.2** or **NEON** instruction set or higher (required by ClickHouse).
2024-09-04 16:21:25 +07:00
- **Memory:** At least **2 GB of RAM** is recommended for running ClickHouse efficiently.
- **Storage:** Adequate disk space to store your ClickHouse and PostgreSQL databases, depending on your expected data volume.
2024-09-04 16:11:58 +07:00
### Quick start
2024-09-04 16:21:46 +07:00
To set up Plausible CE quickly, follow these steps:
2024-09-04 16:11:58 +07:00
1. Clone this repository:
```console
$ git clone -b v2.1.2 --single-branch https://github.com/plausible/community-edition plausible-ce
Cloning into 'plausible-ce'...
remote: Enumerating objects: 13, done.
remote: Counting objects: 100% (10/10), done.
remote: Compressing objects: 100% (9/9), done.
remote: Total 13 (delta 0), reused 7 (delta 0), pack-reused 3 (from 1)
Receiving objects: 100% (13/13), done.
$ cd plausible-ce
$ ls -1
README.md
clickhouse/
compose.yml
```
2024-09-04 16:19:28 +07:00
1. Create and configure your [environment file: ](https://docs.docker.com/compose/environment-variables/ )
2024-09-04 16:11:58 +07:00
```console
$ touch .env
2024-09-04 16:19:28 +07:00
2024-09-04 16:11:58 +07:00
$ echo "HTTP_PORT=8080" >> .env
$ echo "HTTPS_PORT=8443" >> .env
$ echo "BASE_URL=https://plausible.example.com:8443" >> .env
$ echo "SECRET_KEY_BASE=$(docker run -ti --rm ghcr.io/plausible/community-edition:v2.1.2 openssl rand -base64 48)" >> .env
2024-09-04 16:19:28 +07:00
2024-09-04 16:11:58 +07:00
$ cat .env
HTTP_PORT=8080
HTTPS_PORT=8443
BASE_URL=https://plausible.example.com:8443
SECRET_KEY_BASE=As0fZsJlUpuFYSthRjT5Yflg/NlxkFKPRro72xMLXF8yInZ60s6xGGXYVqml+XN1
```
2024-09-04 16:50:30 +07:00
Make sure the `$BASE_URL` is set to the actual domain where you plan to host the service. The domain must have a DNS entry pointing to your server for proper resolution and automatic Let's Encrypt TLS certificate issuance.
2024-09-04 16:47:50 +07:00
2024-09-04 16:11:58 +07:00
1. Start the services with Docker Compose:
```console
$ docker compose up -d
```
2024-09-04 16:24:37 +07:00
1. Visit your instance at `$BASE_URL` and create the first user.
2024-09-04 16:29:46 +07:00
### Wiki
2024-09-04 16:11:58 +07:00
For more information on installation, upgrades, extra configuration, and available integrations please see our [wiki. ](https://github.com/plausible/community-edition/wiki )
2024-09-04 16:29:46 +07:00
### Contact
- For release announcements please go to [GitHub releases. ](https://github.com/plausible/analytics/releases )
- For a question or advice please go to [GitHub discussions. ](https://github.com/plausible/analytics/discussions/categories/self-hosted-support )