configs/plausible
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Reformat readme, update version

Browse Source
This commit is contained in:
Artur Pata
2026-01-16 12:01:22 +02:00
parent d2f69ab4fc
commit 2963f78649
1 changed files with 41 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -20,16 +20,11 @@
### Quick start ### 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.0 --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
@@ -40,7 +35,7 @@
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
@@ -56,7 +51,7 @@
Also ensure `$SECRET_KEY_BASE` is set to at least a **64-byte** string. Also ensure `$SECRET_KEY_BASE` is set to at least a **64-byte** string.
1. Expose Plausible server to the web with a [compose override file:](https://github.com/plausible/community-edition/wiki/compose-override) #### 3. Expose Plausible server to the web with a [compose override file:](https://github.com/plausible/community-edition/wiki/compose-override)
```sh ```sh
$ echo "HTTP_PORT=80" >> .env $ echo "HTTP_PORT=80" >> .env
@@ -73,13 +68,13 @@
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: #### 4. Start the services with Docker Compose:
```console ```console
$ docker compose up -d $ docker compose up -d
``` ```
1. Visit your instance at `$BASE_URL` and create the first user. #### 5. Visit your instance at `$BASE_URL` and create the first user.
> [!NOTE] > [!NOTE]
> Plausible CE is funded by our cloud subscribers. > Plausible CE is funded by our cloud subscribers.