Expose HTTP port

README.md

@@ -20,66 +20,67 @@
 
 ### Quick start
 
-1. Clone this repository:
+#### 1. Clone this repository
 
-    ```console
+```console
-    $ git clone -b v3.1.0 --single-branch https://github.com/plausible/community-edition plausible-ce
+$ git clone -b v3.2.1 --single-branch https://github.com/plausible/community-edition plausible-ce
-    Cloning into '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
+$ cd plausible-ce
 
-    $ ls -1
+$ ls -1
-    clickhouse/
+clickhouse/
-    compose.yml
+compose.yml
-    LICENSE
+LICENSE
-    README.md
+README.md
-    ```
+```
 
-1. Create and configure your [environment](https://docs.docker.com/compose/environment-variables/) file:
+#### 2. Create and configure your [environment](https://docs.docker.com/compose/environment-variables/) file
 
-    ```console
+```console
-    $ touch .env
+$ touch .env
-    $ echo "BASE_URL=https://plausible.example.com" >> .env
+$ echo "BASE_URL=https://plausible.example.com" >> .env
-    $ echo "SECRET_KEY_BASE=$(openssl rand -base64 48)" >> .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.
+$ cat .env
+BASE_URL=https://plausible.example.com
+SECRET_KEY_BASE=...unique secret key base...
+```
 
-   Also ensure `$SECRET_KEY_BASE` is set to at least a **64-byte** string.
+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.
 
-1. Expose Plausible server to the web with a [compose override file:](https://github.com/plausible/community-edition/wiki/compose-override)
+Also ensure `$SECRET_KEY_BASE` is set to at least a **64-byte** string.
 
-    ```sh
+> [!TIP]
-    $ echo "HTTP_PORT=80" >> .env
+> To evaluate CE locally, set `BASE_URL=http://localhost:8000` (or any other port on your system).
-    $ echo "HTTPS_PORT=443" >> .env
 
-    $ cat > compose.override.yml << EOF
+#### 3. Expose Plausible server to the web with a [compose override file:](https://github.com/plausible/community-edition/wiki/compose-override)
-    services:
+
-      plausible:
+```sh
+$ echo "HTTP_PORT=80" >> .env
+$ echo "HTTPS_PORT=443" >> .env
+
+$ cat > compose.override.yml << EOF
+services:
+    plausible:
         ports:
-          - 80:80
+            - 80:80
-          - 443:443
+            - 443:443
-    EOF 
+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)
+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)
 
-1. Start the services with Docker Compose:
+> [!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`.
 
-    ```console
+#### 4. Start the services with Docker Compose:
-    $ docker compose up -d
-    ```
 
-1. Visit your instance at `$BASE_URL` and create the first user.
+```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.

compose.yml

@@ -1,15 +1,4 @@
 services:
-  plausible_db:
-    image: postgres:16-alpine
-    restart: always
-    volumes:
-      - db-data:/var/lib/postgresql/data
-    environment:
-      - POSTGRES_PASSWORD=postgres
-    healthcheck:
-      test: ["CMD-SHELL", "pg_isready -U postgres"]
-      start_period: 1m
-
   plausible_events_db:
     image: clickhouse/clickhouse-server:24.12-alpine
     restart: always
@@ -39,12 +28,10 @@ services:
       start_period: 1m
 
   plausible:
-    image: ghcr.io/plausible/community-edition:v3.1.0
+    image: ghcr.io/plausible/community-edition:v3.2.1
     restart: always
     command: sh -c "/entrypoint.sh db createdb && /entrypoint.sh db migrate && /entrypoint.sh run"
     depends_on:
-      plausible_db:
-        condition: service_healthy
       plausible_events_db:
         condition: service_healthy
     volumes:
@@ -53,6 +40,8 @@ services:
       nofile:
         soft: 65535
         hard: 65535
+    ports:
+      - 5000:8000
     environment:
       - TMPDIR=/var/lib/plausible/tmp
       # required: https://github.com/plausible/community-edition/wiki/configuration#required
@@ -94,7 +83,6 @@ services:
       - SENDGRID_API_KEY
 
 volumes:
-  db-data:
   event-data:
   event-logs:
   plausible-data: