Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.
TypeScript analyticsanalytics-dashboardclickhouseelixirgoogle-analyticsmarketingopen-source-analyticsphoenixplausible-analyticspostgresqlprivacyprivacy-friendlyself-hostedsimple-analyticsstatisticstailwindcssweb-analyticswebsite-analyticswebsite-statswebsite-tracking
Separates CE databases, explains variants (#6768)
Artur Patab8cc135edb03
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdindex 255e08a7e5..dca7a3974d 100644--- a/CONTRIBUTING.md+++ b/CONTRIBUTING.md@@ -11,18 +11,16 @@ Make sure Docker, Elixir, Erlang and Node.js are all installed on your developme### Start the environment1. Run both `make postgres` and `make clickhouse`.-2. You can set up everything with `make install`, alternatively run each command separately:- 1. Run `mix deps.get`. This will download the required Elixir dependencies.- 2. Run `mix ecto.create`. This will create the required databases in both Postgres and Clickhouse.- 3. Run `mix ecto.migrate` to build the database schema.- 4. Run `mix run priv/repo/seeds.exs` to seed the database. Check the [Seeds](#Seeds) section for more.- 5. Run `npm ci --prefix assets` to install the required client-side dependencies.- 6. Run `npm ci --prefix tracker` to install the required tracker dependencies.- 7. Run `mix assets.setup` to install Tailwind and Esbuild- 8. Run `npm run deploy --prefix tracker` to generate tracker files in `priv/tracker/js`- 9. Run `mix download_country_database` to fetch geolocation database+2. You can set up everything with `make install` (see [Makefile](./Makefile)), alternatively run each command separately:+ 1. Run `mix deps.get`. This will download the required Elixir dependencies.+ 2. Run `mix ecto.create`. This will create the required databases in both Postgres and Clickhouse.+ 3. Run `mix ecto.migrate` to build the database schema.+ 4. Run `mix download_country_database` to fetch geolocation database+ 5. Run `npm --prefix assets install` to install the required client-side dependencies.+ 6. Run `npm --prefix tracker install` to install the required tracker dependencies.+ 7. Run `npm --prefix tracker run deploy ` to generate tracker files in `priv/tracker/js`3. Run `make server` or `mix phx.server` to start the Phoenix server.-4. The system is now available on `localhost:8000`.+4. The system is now available on http://localhost:8000.### Seeds@@ -50,6 +48,44 @@ Volumes are preserved. You'll find that the Postgres and Clickhouse state are reNote: Since we are deleting the containers, be careful when deleting volumes with `docker volume prune`. You might accidentally delete the database and would have to go through re-registration process.+### Variants++This repository contains the code for the CE and the EE variants of Plausible. Both versions need to work for the changes to be accepted, so you may need to run both locally to check. To avoid repetition, the commands in this doc are given for the EE variant.++This section explains how to handle the CE variant. EE and CE use the same database servers but different databases, so they need to be seeded separately. When run, the two variants don't interfere with each other.++To run a command for the CE variant, set the env variable `MIX_ENV` to one of `ce_dev` or `ce_test` or `ce`, as appropriate for the command.++#### Examples++- Setup: `make install` -> `MIX_ENV=ce_dev make install`+- Seed data: `mix run priv/repo/seeds.exs` -> `MIX_ENV=ce_dev mix run priv/repo/seeds.exs`+- Run server: `make server` -> `MIX_ENV=ce_dev make server`+- Reset dev database: `mix ecto.reset` -> `MIX_ENV=ce_dev mix ecto.reset`+- Run tests: `mix test` -> **`MIX_ENV=ce_test mix test`**+- Compile: `mix compile` -> `MIX_ENV=ce mix compile`++### Testing++#### End to end tests++1. Run `npm --prefix e2e install` to install the required dependencies.+2. Run `npx --prefix e2e playwright install` to install the browsers.+3. Run `mix test.e2e` to run the tests, `mix test.e2e --ui` for more manual control over runs.++#### Backend unit tests++- Run `mix test`.++#### Dashboard unit tests++- Run `npm --prefix assets test` to run the tests.++#### Tracker end to end tests++1. Run `npx --prefix tracker playwright install` to install the browsers.+2. Run `npm --prefix tracker test` to run the tests, `npm --prefix tracker test -- --ui` for more manual control over runs.+### Pre-commit hooks`pre-commit` requires Python to be available locally and covers Elixir, JavaScript, and CSS. Set up with `pip install --user pre-commit` followed by `pre-commit install`. Conversely, if the prompts are far too bothersome, remove with `pre-commit uninstall`.diff --git a/config/.env.ce_dev b/config/.env.ce_devnew file mode 100644index 0000000000..57f49e37f0--- /dev/null+++ b/config/.env.ce_dev@@ -0,0 +1,4 @@+BASE_URL=http://localhost:8100+HTTP_PORT=8100+DATABASE_URL=postgres://postgres:[email protected]:5432/plausible_ce_dev+CLICKHOUSE_DATABASE_URL=http://127.0.0.1:8123/plausible_ce_events_dbdiff --git a/config/.env.ce_test b/config/.env.ce_testnew file mode 100644index 0000000000..aa100fbb11--- /dev/null+++ b/config/.env.ce_test@@ -0,0 +1,2 @@+DATABASE_URL=postgres://postgres:[email protected]:5432/plausible_ce_test+CLICKHOUSE_DATABASE_URL=http://127.0.0.1:8123/plausible_ce_testdiff --git a/config/runtime.exs b/config/runtime.exsindex d1c0c63b60..610b537a8a 100644--- a/config/runtime.exs+++ b/config/runtime.exs@@ -7,11 +7,11 @@ if config_env() in [:dev, :test, :load] doendif config_env() == :ce_dev do- Envy.load(["config/.env.dev"])+ Envy.load(["config/.env.dev", "config/.env.ce_dev"])endif config_env() == :ce_test do- Envy.load(["config/.env.test"])+ Envy.load(["config/.env.test", "config/.env.ce_test"])endif config_env() == :e2e_test do