A getting started guide to self-hosting 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. - **CPU** must support **SSE 4.2** or **NEON** instruction set or higher (required by ClickHouse). - At least **2 GB of RAM** is recommended for running ClickHouse and Plausible without fear of OOMs. ### Quick start #### 1. Clone this repository ```console $ git clone -b v3.2.0 --single-branch https://github.com/plausible/community-edition plausible-ce Cloning into 'plausible-ce'... $ cd plausible-ce $ ls -1 clickhouse/ compose.yml LICENSE README.md ``` #### 2. Create and configure your [environment](https://docs.docker.com/compose/environment-variables/) file ```console $ touch .env $ echo "BASE_URL=https://plausible.example.com" >> .env $ echo "SECRET_KEY_BASE=$(openssl rand -base64 48)" >> .env $ cat .env BASE_URL=https://plausible.example.com SECRET_KEY_BASE=As0fZsJlUpuFYSthRjT5Yflg/NlxkFKPRro72xMLXF8yInZ60s6xGGXYVqml+XN1 ``` Make sure `$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. More on that in the next step. Also ensure `$SECRET_KEY_BASE` is set to at least a **64-byte** string. > [!TIP] > To evaluate CE locally, set `BASE_URL=http://localhost:8000` (or any other port on your system). #### 3. Expose Plausible server to the web with a [compose override file:](https://github.com/plausible/community-edition/wiki/compose-override) ```sh $ echo "HTTP_PORT=80" >> .env $ echo "HTTPS_PORT=443" >> .env $ cat > compose.override.yml << EOF services: plausible: ports: - 80:80 - 443:443 EOF ``` Setting `HTTP_PORT=80` and `HTTPS_PORT=443` enables automatic Let's Encrypt TLS certificate issuance. You might want to choose different values if, for example, you plan to run Plausible behind [a reverse proxy.](https://github.com/plausible/community-edition/wiki/reverse-proxy) > [!TIP] > To evaluate CE locally, you only need to set `HTTP_PORT` and expose it on the system port from the previous step, e.g. for `BASE_URL=http://localhost:8000` and server `HTTP_PORT=80`, `ports` override should be `- 8000:80`. #### 4. Start the services with Docker Compose: ```console $ docker compose up -d ``` #### 5. Visit your instance at `$BASE_URL` and create the first user. > [!NOTE] > Plausible CE is funded by our cloud subscribers. > > If you know someone who might [find Plausible useful](https://plausible.io/?utm_medium=Social&utm_source=GitHub&utm_campaign=readme), we'd appreciate if you'd let them know. ### Wiki For more information on installation, upgrades, configuration, and integrations please see our [wiki.](https://github.com/plausible/community-edition/wiki) ### 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)