Multiuser and OpenId #447
Multiuser and OpenId #447
Conversation
✅ Deploy Preview for actualbudget-website ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
I hope I have not been to crass in my comments and suggestions.
Also please do not use the backtick when referring to elements in the UI, use italics or bold to reference the elements and bold or italics to reference the content of the elements. Italics are preferred over bold to reference elements.
|
|
||
| ## Setup | ||
|
|
||
| This feature needs to be enabled on the server, it is not configured to work out of the box. In the Actual config, set the value `multiuser` or env `ACTUAL_MULTIUSER` to `"true"`. This will enable multiuser support. |
There was a problem hiding this comment.
The left menu item in the program is called "Actual Setup" and not "Actucal config". I think the documentation needs to reflect this.
I would also suggest that you show a screenshot.
| This feature needs to be enabled on the server, it is not configured to work out of the box. In the Actual config, set the value `multiuser` or env `ACTUAL_MULTIUSER` to `"true"`. This will enable multiuser support. | ||
|
|
||
| :::warning | ||
| The first user to login, after enabling multiuser (and OpenID Provider), will be considered the `master` user. Master users **cannot** be deleted nor change the role from Admin to Basic. But you can change the username manually. |
There was a problem hiding this comment.
| The first user to login, after enabling multiuser (and OpenID Provider), will be considered the `master` user. Master users **cannot** be deleted nor change the role from Admin to Basic. But you can change the username manually. | |
| The first user to log in after enabling multiuser (and OpenID Provider) will be considered the `master` user. Master users **cannot** be deleted or their role changed from Admin to Basic, but their usernames can be changed manually. |
|
|
||
|  | ||
|
|
||
| Users can be `Basic` or `Admin`. |
There was a problem hiding this comment.
| Users can be `Basic` or `Admin`. | |
| There are two user roles _Basic_ or _Admin_. |
|
|
||
| Users can be `Basic` or `Admin`. | ||
|
|
||
| - Basic: |
There was a problem hiding this comment.
| - Basic: | |
| - The Basic role: |
| Users can be `Basic` or `Admin`. | ||
|
|
||
| - Basic: | ||
| Users with the Basic role can create new budgets and be invited to collaborate on budgets created by others. |
There was a problem hiding this comment.
| Users with the Basic role can create new budgets and be invited to collaborate on budgets created by others. | |
| Users with the Basic role can create new budgets and collaborate on budgets made by others. |
Shorter sentences are easier to read than longer ones.
|
|
||
| #### After setup: | ||
|
|
||
| You will be redirected to login page: |
There was a problem hiding this comment.
This is an incomplete sentence. My suggestion:
| You will be redirected to login page: | |
| When setup is done, you will be redirected to the _login_ page: |
|  | ||
|
|
||
| ### Next Step | ||
| Once OpenID provider is setup. Setup [Multiuser](multi-user) |
There was a problem hiding this comment.
Incomplete sentences. My suggestion:
| Once OpenID provider is setup. Setup [Multiuser](multi-user) | |
| Once you have configured your OpenID, you can continue to enable [Multiuser](multi-user) login. |
|
|
||
|
|
||
| :::tip | ||
| Configuring OpenID provider from options or bootstrap can be only done if your provider supports discovery, otherwise, use [file configuration](oauth-auth#config-using-configuration-file) |
There was a problem hiding this comment.
A lot is going on there at the same time. Alo be only should be only be. Bootstrap is, as stated above, a bit iffy to use.
I suggest the following:
| Configuring OpenID provider from options or bootstrap can be only done if your provider supports discovery, otherwise, use [file configuration](oauth-auth#config-using-configuration-file) | |
| Configuring the OpenID provider from options or during the initial setup for Actual can only be done if your provider supports discovery; otherwise, use [file configuration](oauth-auth#config-using-configuration-file) |
| Server Version 24.10.0 or higher are required for this feature. | ||
| ::: | ||
|
|
||
| This feature enables multiple users to login into Actual. For now, you need to enable [OpenId Provider auth](oauth-auth). The usernames will be fetched from the provider. |
There was a problem hiding this comment.
You need to clearly state that to before you can configure Multi User Support, you need to enable OpenID.
| @@ -0,0 +1,50 @@ | |||
| # Multi user support | |||
There was a problem hiding this comment.
Usually, each word in the headings is in upper case. If you prefer not to have this, you must be consistent across the document.
Multi User is spelled with a hypen.
Also - maybe change the title to:
| # Multi user support | |
| # Managing Multi-User Support |
|
@RubenOlsen thanks for your dedication on this. Took this long for me to notice that you reviewed this. |
No description provided.