github.com/plausible-hosting
1
0
Fork 1
mirror of https://github.com/plausible/hosting.git synced 2025-01-15 14:34:30 -06:00
Code Issues Projects Releases Wiki Activity
9bdc8c577a
plausible-hosting/README.md
ruslandoga e1fdf6cc78
Update README.md
2024-09-05 21:38:48 +07:00

2.3 KiB
Raw Blame History

Plausible Community Edition

Prerequisites

  • Docker and Docker Compose 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

To set up Plausible CE quickly, follow these steps:

  1. Clone this repository:

    $ 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

  2. Create and configure your environment file:

    $ touch .env

$ echo "HTTP_PORT=80" >> .env
$ echo "HTTPS_PORT=443" >> .env
$ echo "BASE_URL=https://plausible.example.com" >> .env
$ echo "SECRET_KEY_BASE=$(openssl rand -base64 48)" >> .env

$ cat .env
HTTP_PORT=80
HTTPS_PORT=443
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.

  3. Start the services with Docker Compose:

    $ docker compose up -d

  4. Visit your instance at $BASE_URL and create the first user.

Wiki

For more information on installation, upgrades, configuration, and integrations please see our wiki.

Contact