{"id":13554070,"url":"https://github.com/plausible/community-edition","last_synced_at":"2025-05-14T14:06:21.067Z","repository":{"id":37474701,"uuid":"299603525","full_name":"plausible/community-edition","owner":"plausible","description":"Example Docker Compose setup for hosting Plausible Community Edition","archived":false,"fork":false,"pushed_at":"2025-04-11T10:00:40.000Z","size":11128,"stargazers_count":1832,"open_issues_count":19,"forks_count":344,"subscribers_count":32,"default_branch":"v3.0.1","last_synced_at":"2025-05-08T11:02:04.456Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/plausible.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-09-29T12:01:24.000Z","updated_at":"2025-05-07T10:07:21.000Z","dependencies_parsed_at":"2024-05-10T10:30:42.072Z","dependency_job_id":"792dddc2-fd9e-4035-9a68-9f5c69e761e2","html_url":"https://github.com/plausible/community-edition","commit_stats":null,"previous_names":["plausible/hosting"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plausible%2Fcommunity-edition","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plausible%2Fcommunity-edition/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plausible%2Fcommunity-edition/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plausible%2Fcommunity-edition/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/plausible","download_url":"https://codeload.github.com/plausible/community-edition/tar.gz/refs/heads/v3.0.1","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254159176,"owners_count":22024558,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T12:02:39.028Z","updated_at":"2025-05-14T14:06:21.059Z","avatar_url":"https://github.com/plausible.png","language":null,"funding_links":[],"categories":["Others","miscellaneous"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003cpicture\u003e\n        \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/plausible/community-edition/refs/heads/v2.1.1/images/logo_dark.svg\" width=\"300\"\u003e\n        \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://raw.githubusercontent.com/plausible/community-edition/refs/heads/v2.1.1/images/logo_light.svg\" width=\"300\"\u003e\n        \u003cimg src=\"https://raw.githubusercontent.com/plausible/community-edition/refs/heads/v2.1.1/images/logo_light.svg\" width=\"300\"\u003e\n    \u003c/picture\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    A getting started guide to self-hosting \u003ca href=\"https://plausible.io/blog/community-edition\"\u003ePlausible Community Edition\u003c/a\u003e\n\u003c/p\u003e\n\n---\n\n### Prerequisites\n\n- **[Docker](https://docs.docker.com/engine/install/)** and **[Docker Compose](https://docs.docker.com/compose/install/)** must be installed on your machine.\n- **CPU** must support **SSE 4.2** or **NEON** instruction set or higher (required by ClickHouse).\n- At least **2 GB of RAM** is recommended for running ClickHouse and Plausible without fear of OOMs.\n\n### Quick start\n\n1. Clone this repository:\n\n    ```console\n    $ git clone -b v3.0.1 --single-branch https://github.com/plausible/community-edition plausible-ce\n    Cloning into 'plausible-ce'...\n    remote: Enumerating objects: 13, done.\n    remote: Counting objects: 100% (10/10), done.\n    remote: Compressing objects: 100% (9/9), done.\n    remote: Total 13 (delta 0), reused 7 (delta 0), pack-reused 3 (from 1)\n    Receiving objects: 100% (13/13), done.\n\n    $ cd plausible-ce\n\n    $ ls -1\n    README.md\n    clickhouse/\n    compose.yml\n    ```\n\n1. Create and configure your [environment](https://docs.docker.com/compose/environment-variables/) file:\n\n    ```console\n    $ touch .env\n    $ echo \"BASE_URL=https://plausible.example.com\" \u003e\u003e .env\n    $ echo \"SECRET_KEY_BASE=$(openssl rand -base64 48)\" \u003e\u003e .env\n    \n    $ cat .env\n    BASE_URL=https://plausible.example.com\n    SECRET_KEY_BASE=As0fZsJlUpuFYSthRjT5Yflg/NlxkFKPRro72xMLXF8yInZ60s6xGGXYVqml+XN1\n    ```\n\n    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.\n\n1. Expose Plausible server to the web with a [compose override file:](https://github.com/plausible/community-edition/wiki/compose-override)\n\n    ```sh\n    $ echo \"HTTP_PORT=80\" \u003e\u003e .env\n    $ echo \"HTTPS_PORT=443\" \u003e\u003e .env\n\n    $ cat \u003e compose.override.yml \u003c\u003c EOF\n    services:\n      plausible:\n        ports:\n          - 80:80\n          - 443:443\n    EOF \n    ```\n\n    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)\n\n1. Start the services with Docker Compose:\n\n    ```console\n    $ docker compose up -d\n    ```\n\n1. Visit your instance at `$BASE_URL` and create the first user.\n\n\u003e [!NOTE]\n\u003e Plausible CE is funded by our cloud subscribers.\n\u003e\n\u003e If you know someone who might [find Plausible useful](https://plausible.io/?utm_medium=Social\u0026utm_source=GitHub\u0026utm_campaign=readme), we'd appreciate if you'd let them know.\n\n### Wiki\n\nFor more information on installation, upgrades, configuration, and integrations please see our [wiki.](https://github.com/plausible/community-edition/wiki)\n\n### Contact\n\n- For release announcements please go to [GitHub releases.](https://github.com/plausible/analytics/releases)\n- For a question or advice please go to [GitHub discussions.](https://github.com/plausible/analytics/discussions/categories/self-hosted-support)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplausible%2Fcommunity-edition","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fplausible%2Fcommunity-edition","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplausible%2Fcommunity-edition/lists"}