Adds "invite_only" disable_registration config option #1841

Vigasaurus · 2022-04-19T12:45:08Z

Changes

Allows for the DISABLE_REGISTRATION config flag to support three states.
false => registration is allowed as normal, for both normal users and invited users
invite_only => registration is allowed for those with an invite link, but prevented for normal users
true => registration is entirely disabled, regardless of invite status

@jesperordrup - after taking a look, this honestly was too trivial to implement for me to actually expect or accept a bounty for it (assuming it is good enough in its current state).

I'll add the docs + changelog entry after confirming the implementation.

Tests

Automated tests have been ~~added~~ updated

Changelog

Entry has been added to changelog

Documentation

Docs have been updated

Dark mode

This PR does not change the UI

bundlemon · 2022-04-19T12:46:48Z

BundleMon

Unchanged files (7)

Status	Path	Size	Limits
✅	static/css/app.css	515.1KB	-
✅	static/js/dashboard.js	286.81KB	-
✅	static/js/app.js	12.13KB	-
✅	static/js/embed.host.js	5.58KB	-
✅	static/js/embed.content.js	5.06KB	-
✅	tracker/js/plausible.js	751B	-
✅	static/js/applyTheme.js	314B	-

No change in files bundle size

Final result: ✅

View report in BundleMon website ➡️

Current branch size history | Target branch size history

ukutaht

Looks good. Let's make the field a bit more restrictive so a random value wouldn't be accepted. But then we can merge indeed

config/runtime.exs

jesperordrup · 2022-04-19T13:31:43Z

@jesperordrup - after taking a look, this honestly was too trivial to implement for me to actually expect or accept a bounty for it (assuming it is good enough in its current state).

@Vigasaurus Wow! That is generous. let me know if something changes.

Thank you for the speedy update. Lets hope theres a release in near future.

ukutaht · 2022-05-03T07:44:37Z

Thanks @Vigasaurus !

@jesperordrup this will be part of the next self-hosted release. Coming soon.

jesperordrup · 2022-05-27T16:11:29Z

"coming soon" is of course a matter of interpretation. Initially I held my breath but I found that it wasn't possible 👍😂

ukutaht · 2022-05-30T06:19:19Z

I'm sorry @jesperordrup, I'm having to deal with some unexpected health issues. The release is coming as soon as possible.

jesperordrup · 2022-05-30T06:51:36Z

Oh. Get well and forget my "funny" comment Pls

* Adds tri-state disable_registration config * Formatting * Changes variable back to atom * Changelog * Uses atoms correctly :/ * Swaps to a more fitting value * Formatting

jesperordrup · 2022-06-23T11:28:13Z

Hi all. Hope that all is well. Any news?

metmarkosaric · 2022-06-23T11:35:07Z

hi @jesperordrup! no news at the moment. this is on our self-hosted roadmap but we have no timelines that we can promise. we have limited resources and the self-hosted release depends on the free capacity of our developers. as soon as there's news we will post an update, thanks!

jesperordrup · 2022-06-23T13:13:46Z

no news at the moment. this is on our self-hosted roadmap but we have no timelines that we can promise. we have limited resources and the self-hosted release depends on the free capacity of our developers. as soon as there's news we will post an update, thanks!

I know, all fine. I'm aware of the setup. But in the end, it's also about if the setup works for me. This is not your concern, of course. But I of course have to deal with the consequences. Not complaining in any way - as I say - I'm aware of the setup. Just asking because initially it was "coming soon". So I'd thought I just ask.

metmarkosaric · 2022-06-23T13:38:42Z

our goal is two releases per year. last version was released less than 5 months ago. we're hoping for the next one to be done in the next month or so but no guarantees or promises. we have a goal of twice per year and we hope to make it every time but things are unpredictable as we have limited resources. we will publish the release as soon as it's ready.

jesperordrup · 2022-08-06T14:21:14Z

I just tested the the invite_only feature using docker:

changed the image referenced in the docker-compose.yml file to:


  plausible:
    image: plausible/analytics:master

and updated plausible-conf.env

DISABLE_REGISTRATION=invite_only

Now I can Invite but when I click on the invitation link im taken to the login screen. Is this where its at or has I missed something`?

Clicking the link http://localhost:8000/register/invitation/wIus542ERPZMPyFDQkhCK
results in a 302 redirect with the following response headers:

ruslandoga · 2022-10-12T06:44:47Z

@jesperordrup hi! Could you please try out the new release candidate #2324 and check if it works better there?

jesperordrup · 2022-12-14T12:41:45Z

I just tested the new release.

What I did

Updated DISABLE_REGISTRATION=invite_only
restarted
opened a website configuration
invited a new user and set to viewer
received the email
clicked the link and opened page that allows me to login

Error
shows login dialog

What should have happened
show dialog to proceed with the invitation (register)

Recap of what the purpose of invite_only is

Enable the possibility for an admin to add a website and invite new users as admins or viewers to this website.
Only allow anyone with an invitation to create an account and access a website

ruslandoga · 2022-12-14T13:05:39Z

👋 @jesperordrup

I'm having trouble reproducing this error on my instance...

Can you please check the database to include the invitation, check its timestamp? Can you please post the URL that was sent in the email? Are there any errors in the logs / console?

You can also try connecting to your running app with

$ docker compose exec -ti plausible bin/plausible remote

and then listing the invitations there (please post them here)

iex> Plausible.Repo.all Plausible.Auth.Invitation
[
  %Plausible.Auth.Invitation{
    __meta__: #Ecto.Schema.Metadata<:loaded, "invitations">,
    email: "zlobushka666@gmail.com",
    id: 2,
    inserted_at: ~N[2022-12-14 12:59:09],
    invitation_id: "kWkcqBGrobbKT0r9aef1x",
    inviter: #Ecto.Association.NotLoaded<association :inviter is not loaded>,
    inviter_id: 1,
    role: :viewer,
    site: #Ecto.Association.NotLoaded<association :site is not loaded>,
    site_id: 2,
    updated_at: ~N[2022-12-14 12:59:09]
  }
]

I'm also interested in what this command returns

iex> Application.get_env :plausible, :selfhost
[enable_email_verification: false, disable_registration: :invite_only]

jesperordrup · 2022-12-15T09:26:09Z

thanks @ruslandoga.

This is running on a coolify setup using:

Plausible has been updated with 1.51 (its not a new install)

The invite url looks like this:
https://hostname/register/invitation/7TbLQUYS2Kxf24PIgzsqZ

When hitting it I get a 302 to

https://hostname/login

When I create the invite the log updates with:

2022-12-15T09:21:16.678742662Z
2022-12-15T09:21:16.678728204Z Reason: 'Option {verify, verify_peer} and cacertfile/cacerts is missing'
2022-12-15T09:21:16.678667782Z 09:21:16.678 request_id=FzDtBxrXLRVr_cMAAcMB [warning] Description: 'Authenticity is not established by certificate path validation'

When I click the invite url, nothing happens in log or browser console (other than redirect to login)

ruslandoga · 2022-12-15T09:33:45Z

I'm not familiar with Coolify, unfortunately. Does it allow you to connect to the running plausible container the way I showed above?

Since it's a not a docker compose setup, can you verify the image is indeed updated and the container is running the new image version, v1.5.1?

jesperordrup · 2022-12-15T09:38:07Z

I've tried

$ docker exec -ti plausible bin/plausible remote

And ran Plausible.Repo.all Plausible.Auth.Invitation

  %Plausible.Auth.Invitation{
    __meta__: #Ecto.Schema.Metadata<:loaded, "invitations">,
    email: "p@umakers.dk",
    id: 17,
    inserted_at: ~N[2022-12-15 09:13:05],
    invitation_id: "7TbLQUYS2Kxf24PIgzsqZ",
    inviter: #Ecto.Association.NotLoaded<association :inviter is not loaded>,
    inviter_id: 1,
    role: :admin,
    site: #Ecto.Association.NotLoaded<association :site is not loaded>,
    site_id: 13,
    updated_at: ~N[2022-12-15 09:13:05]
  },
  %Plausible.Auth.Invitation{
    __meta__: #Ecto.Schema.Metadata<:loaded, "invitations">,
    email: "p2@umakers.dk",
    id: 18,
    inserted_at: ~N[2022-12-15 09:21:16],
    invitation_id: "W1_yCm4y7j_mf5v3QpsA_",
    inviter: #Ecto.Association.NotLoaded<association :inviter is not loaded>,
    inviter_id: 1,
    role: :admin,
    site: #Ecto.Association.NotLoaded<association :site is not loaded>,
    site_id: 13,
    updated_at: ~N[2022-12-15 09:21:16]
  }
]

Also this one
iex(plausible@bac8ad241df6)2> Application.get_env :plausible, :selfhost

Result (which clearly indicates a problem 🥇 )
[enable_email_verification: false, disable_registration: true]

Wonder why disable_registration is true. In Coolify I've added this (and redeployed)

ruslandoga · 2022-12-15T09:41:21Z

I'd try adding some dummy env vars and checking them from the running container with System.get_env.

iex> System.get_env("DUMMY")
"value"

If they do show up, then I'd try changing one of them and checking the change with System.get_env again.

iex> System.get_env("DUMMY")
"updated_value"

If new env vars don't show up or are not updated, the issue is somewhere with Coolify.

jesperordrup · 2022-12-15T10:46:34Z

I tested some more:

When I enter the container and do a
System.get_env("DISABLE_REGISTRATION")

It always returns "true". Any changes I make to the env var in coolify is ignored.

I then added a new environment variable "FISK" to the service

System.get_env("FISK")

Any changes to this IS updated without problem.

ruslandoga · 2022-12-15T11:09:17Z

Could there be multiple places where this env var is set? I see "Secrets" in your screenshot, is there a place for non-secret env vars maybe?

Could you try a fresh installation?

jesperordrup · 2022-12-16T14:32:25Z

Solved. You're right! Coolify is overriding. They have added direct support for DISABLE_REGISTRATION which does not include invite_only - I've notified Coolify.

Im installing in another setup.

Thanks for your help

jesperordrup · 2022-12-16T14:46:56Z

Aaaand just finished testing on a local docker. Its working great !!! Assuming that it sends out the invite (i just grabbed the invitation id from ( Plausible.Repo.all Plausible.Auth.Invitation ) and composed the invite url

/registration/invitation/MWHzC0_f1f_dNplXQxQAZ

And it worked!

Awesome - I can setup a server. Yay :-)

Adds tri-state disable_registration config

a1933fd

Formatting

701abcd

ukutaht reviewed Apr 19, 2022

View reviewed changes

config/runtime.exs Show resolved Hide resolved

Vigasaurus added 4 commits April 19, 2022 08:33

Changes variable back to atom

cc27b09

Changelog

412ef5a

Uses atoms correctly :/

84abf8d

Swaps to a more fitting value

cf27a96

Vigasaurus changed the title ~~Adds "allow-invites" disable_registration config option~~ Adds "invite_only" disable_registration config option Apr 20, 2022

Formatting

1041312

ukutaht merged commit b7b69c6 into plausible:master May 3, 2022

jesperordrup mentioned this pull request Dec 29, 2022

[Bug]: plausible configuration features are not valid coollabsio/coolify#815

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds "invite_only" disable_registration config option #1841

Adds "invite_only" disable_registration config option #1841

Vigasaurus commented Apr 19, 2022 •

edited

bundlemon bot commented Apr 19, 2022 •

edited

ukutaht left a comment

jesperordrup commented Apr 19, 2022

ukutaht commented May 3, 2022

jesperordrup commented May 27, 2022

ukutaht commented May 30, 2022

jesperordrup commented May 30, 2022

jesperordrup commented Jun 23, 2022

metmarkosaric commented Jun 23, 2022

jesperordrup commented Jun 23, 2022

metmarkosaric commented Jun 23, 2022

jesperordrup commented Aug 6, 2022 •

edited

ruslandoga commented Oct 12, 2022

jesperordrup commented Dec 14, 2022 •

edited

ruslandoga commented Dec 14, 2022 •

edited

jesperordrup commented Dec 15, 2022

ruslandoga commented Dec 15, 2022 •

edited

jesperordrup commented Dec 15, 2022

ruslandoga commented Dec 15, 2022 •

edited

jesperordrup commented Dec 15, 2022 •

edited

ruslandoga commented Dec 15, 2022 •

edited

jesperordrup commented Dec 16, 2022

jesperordrup commented Dec 16, 2022

Adds "invite_only" disable_registration config option #1841

Adds "invite_only" disable_registration config option #1841

Conversation

Vigasaurus commented Apr 19, 2022 • edited

Changes

Tests

Changelog

Documentation

Dark mode

bundlemon bot commented Apr 19, 2022 • edited

BundleMon

ukutaht left a comment

Choose a reason for hiding this comment

jesperordrup commented Apr 19, 2022

ukutaht commented May 3, 2022

jesperordrup commented May 27, 2022

ukutaht commented May 30, 2022

jesperordrup commented May 30, 2022

jesperordrup commented Jun 23, 2022

metmarkosaric commented Jun 23, 2022

jesperordrup commented Jun 23, 2022

metmarkosaric commented Jun 23, 2022

jesperordrup commented Aug 6, 2022 • edited

ruslandoga commented Oct 12, 2022

jesperordrup commented Dec 14, 2022 • edited

ruslandoga commented Dec 14, 2022 • edited

jesperordrup commented Dec 15, 2022

ruslandoga commented Dec 15, 2022 • edited

jesperordrup commented Dec 15, 2022

ruslandoga commented Dec 15, 2022 • edited

jesperordrup commented Dec 15, 2022 • edited

ruslandoga commented Dec 15, 2022 • edited

jesperordrup commented Dec 16, 2022

jesperordrup commented Dec 16, 2022

Vigasaurus commented Apr 19, 2022 •

edited

bundlemon bot commented Apr 19, 2022 •

edited

jesperordrup commented Aug 6, 2022 •

edited

jesperordrup commented Dec 14, 2022 •

edited

ruslandoga commented Dec 14, 2022 •

edited

ruslandoga commented Dec 15, 2022 •

edited

ruslandoga commented Dec 15, 2022 •

edited

jesperordrup commented Dec 15, 2022 •

edited

ruslandoga commented Dec 15, 2022 •

edited