12 Commits

Author SHA1 Message Date
d4324158d8 Create LICENSE 2024-12-04 19:19:32 +07:00
4e949e84f7 Revert "Add health check to docker compose (#141)"
This reverts commit 43e8842846.
2024-08-02 22:35:10 +07:00
9cd73d990c Revert "remove sleep from plausible.command"
This reverts commit 5930193510.
2024-08-02 22:35:05 +07:00
5930193510 remove sleep from plausible.command 2024-07-22 13:48:24 +07:00
bfcbf76cde run spellcheck on all pushes 2024-07-22 13:44:11 +07:00
26c2804763 add spellcheckers 2024-07-22 13:40:46 +07:00
250fabfa65 Update README.md (#144) 2024-07-21 00:48:45 +07:00
43e8842846 Add health check to docker compose (#141)
* Add healtcheck to docker compose

* Add start interval for faster startup
2024-07-16 16:06:01 +07:00
e023cf8874 Add ws proxy to apache2/plausible.conf
Websocket connections on apache2 were failing until it was routed correctly - caused tocket creation to fail.
2024-06-19 02:47:49 +07:00
92f2445fbe Disable IPv6 in Clickhouse config (#137) 2024-06-17 02:27:46 +07:00
8152c57c31 update comment 2024-06-06 20:26:23 +07:00
5632dbc22f v2.1.1 2024-06-06 20:23:00 +07:00
6 changed files with 57 additions and 7 deletions

20
.github/workflows/spellcheck.yml vendored Normal file
View File

@ -0,0 +1,20 @@
name: spellcheck
on:
pull_request:
push:
jobs:
codespell:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: codespell-project/actions-codespell@v2
with:
check_filenames: true
typos:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: crate-ci/typos@master

21
LICENSE Normal file
View File

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2024 Plausible Analytics
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@ -902,14 +902,14 @@ You'll receive an email once the data is imported.
### MaxMind integration
To use MaxMind you need to create an account [here.](https://www.maxmind.com/en/geolite2/signup) Once you have your account details, you can add [MAXMIND_LICENSE_KEY](#maxmind_license_key) and [MAXMIND_EDITION](#maxmind_edition) environmental valiables to your [plausible-conf.env](./plausible-conf.env) and the databases would be automatically downloaded and kept up to date. Note that using city-level databases like MaxMind's GeoLite2-City requires ~1GB more RAM.
To use MaxMind you need to create an account [here.](https://www.maxmind.com/en/geolite2/signup) Once you have your account details, you can add [MAXMIND_LICENSE_KEY](#maxmind_license_key) and [MAXMIND_EDITION](#maxmind_edition) environmental variables to your [plausible-conf.env](./plausible-conf.env) and the databases would be automatically downloaded and kept up to date. Note that using city-level databases like MaxMind's GeoLite2-City requires ~1GB more RAM.
## FAQ
<details>
<summary>How do I access Plausible from terminal?</summary>
You can starts an Interactive Elixir session from within the `plausible` container:
You can start an Interactive Elixir session from within the `plausible` container:
<sub><kbd>console</kbd></sub>
```console
@ -937,7 +937,7 @@ iex> Application.get_all_env :plausible
<details>
<summary>How do I access ClickHouse from terminal?</summary>
You can starts a `clickhouse client` session from within the `plausible_events_db` container:
You can start a `clickhouse client` session from within the `plausible_events_db` container:
<sub><kbd>console</kbd></sub>
```console
@ -975,7 +975,7 @@ $ docker compose exec plausible_events_db clickhouse client --database plausible
<details>
<summary>How do I access PostgreSQL from terminal?</summary>
You can starts a `psql` session from within the `plausible_db` container:
You can start a `psql` session from within the `plausible_db` container:
<sub><kbd>console</kbd></sub>
```console

View File

@ -3,6 +3,13 @@
<level>warning</level>
<console>true</console>
</logger>
<!--
Avoid the warning: "Listen [::]:9009 failed: Address family for hostname not supported".
If Docker has IPv6 disabled, bind ClickHouse to IPv4 to prevent this issue.
Add this to the configuration to ensure it listens on all IPv4 interfaces:
<listen_host>0.0.0.0</listen_host>
-->
<!-- Stop all the unnecessary logging -->
<query_thread_log remove="remove"/>

View File

@ -1,7 +1,7 @@
services:
plausible_db:
# Plausible v2.1.0 was tested against PostgreSQL versions 15 and 16
# https://github.com/plausible/analytics/blob/v2.1.0/.github/workflows/elixir.yml#L21-L32
# Plausible v2.1.1 was tested against PostgreSQL versions 15 and 16
# https://github.com/plausible/analytics/blob/v2.1.1/.github/workflows/elixir.yml#L21-L32
image: postgres:16-alpine
restart: always
volumes:
@ -23,7 +23,7 @@ services:
hard: 262144
plausible:
image: ghcr.io/plausible/community-edition:v2.1.0
image: ghcr.io/plausible/community-edition:v2.1.1
restart: always
command: sh -c "sleep 10 && /entrypoint.sh db createdb && /entrypoint.sh db migrate && /entrypoint.sh run"
depends_on:

View File

@ -4,6 +4,8 @@
ServerName example.com
ProxyPreserveHost On
ProxyAddHeaders On
ProxyPassMatch ^/(live/websocket)$ ws://localhost:8000/$1
ProxyPass / http://localhost:8000/
ProxyPassReverse / http://localhost:8000/