v1.5.0-rc.1

[ruslandoga]

Admin user registration is now done through the UI instead of configuration variables. At first launch, users are presented with a registration page which will create the admin account. Admin account related configuration variables are ignored going forward. See below for details.

Admin user registration is required from 1.5.0 onwards. We are deprecating the DISABLE_AUTH option which allowed Plausible to be used without any user account at all.

Users with existing admin accounts are not affected, but we recommend removing the unused configuration variables. A benefit of moving admin account management to the UI is that you can now change the admin email account through the UI. Previously, this was done by manual database changes and configuration change which required restarting the service.

For v1.5.0-rc.0 changes and upgrade steps please see the previous release candidate discussion.

Upgrading Plausible Analytics to v1.5.0-rc.1

In your docker-compose.yml update the image used for plausible to tag v1.5.0-rc.1:

plausible:
- image: plausible/analytics:1.5.0-rc.0
+ image: plausible/analytics:v1.5.0-rc.1

Restart the container

$ docker compose stop plausible
$ docker compose rm plausible
$ docker compose up -d

This will boot up the new version of the app.

Removing deprecated commands and environment variables (Optional, but recommended)

ADMIN_USER_EMAIL, ADMIN_USER_NAME, ADMIN_USER_PWD, DISABLE_AUTH environment variables are no longer supported and are ignored if set.

Please remove them from plausible-conf.env:

- ADMIN_USER_EMAIL=replace-me
- ADMIN_USER_NAME=replace-me
- ADMIN_USER_PWD=replace-me
- DISABLE_AUTH=true
  BASE_URL=replace-me
  SECRET_KEY_BASE=replace-me

/entrypoint.sh db init-admin command that was responsible for creating the admin user is also deprecated.

Please remove it from docker-compose.yml:

plausible:
  image: plausible/analytics:v1.5.0-rc.1
- command: sh -c "sleep 10 && /entrypoint.sh db createdb && /entrypoint.sh db migrate && /entrypoint.sh db init-admin && /entrypoint.sh run"
+ command: sh -c "sleep 10 && /entrypoint.sh db createdb && /entrypoint.sh db migrate && /entrypoint.sh run"

Changelog

Following changes have been made since v1.5.0-rc.0:

Added

• Allow self-hosters to register an account on first launch

Deprecated

• DISABLE_AUTH is no longer supported

---

This discussion was created from the release v1.5.0-rc.1.

[timscha]

I got this error when following the update instructions:

Error response from daemon: manifest for plausible/analytics:1.5.0-rc.1 not found: manifest unknown: manifest unknown

[ruslandoga]

The image tag is plausible/analytics:v1.5.0-rc.1, please note the v.

The missing v in 1.5.0-rc.0 was a mistake on our part: #2324 (comment)

[timscha]

Upsi, I missed the v. Thanks @ruslandoga :)

[joshavant]

@ruslandoga Thanks for the great work on this.

Is the Geonames CSV necessary to get city-level geolocation working?

Does the official Plausible Docker download the Geonames CSV, or is there a Docker Hub source for this?

[ruslandoga]

@joshavant 👋

Yeah, geonames are necessary as they provide the mapping of geoname id -> human-readable place name. Here's a guide to setup city-level geolocation.

[mattvb91]

How do I create a user now without /entrypoint.sh db init-admin? I boot my full stack in github actions to make sure analytics etc.. is working throughout my apps with various events but now I need to manually register via web ui? How do you create it via script now?

[ruslandoga]

👋 @mattvb91

You might be able to mount a custom priv/repo/seeds.exs script which'd create a user and some sites and then run it with bin/plausible eval "Plausible.Release.seed()" (I'll make a demo github ci action with this approach today)

[ruslandoga]

Demo: https://github.com/ruslandoga/plausible-seeds-ci

[mattvb91]

Thank you! Apreciated 👍

[ruslandoga]

v1.5.1 has been released.

[ErikHumphrey]

Any recommended replacement for DISABLE_AUTH for those using an OAuth2 proxy, Keycloak, etc. in front of Plausible? I.e., to automatically sign in as the admin user if the app is otherwise secured.

[ruslandoga]

👋 @ErikHumphrey

I don't think there is any replacement for DISABLE_AUTH right now.

[ruslandoga]

👋

#2896 v2.0.0-rc.0 is now available.