TerribleDev/ente
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[docs] Document first user as admin (#2871)

Browse Source 
https://github.com/ente-io/ente/pull/2869/
This commit is contained in:
Manav Rathi
2024-08-24 17:03:27 +05:30
committed by GitHub
parent 8fc319abdf d0a485f8aa
commit f82df77bf8
2 changed files with 32 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/docs/self-hosting/faq/index.md
View File

@@ -31,3 +31,10 @@ particular, you can use the `ente admin update-subscription` CLI command to
increase the
[storage and account validity](https://github.com/ente-io/ente/blob/main/cli/docs/generated/ente_admin_update-subscription.md)
of accounts on your instance.
### How can I become an admin on my self hosted instance?
The first user you create on your instance is treated as an admin.
If you want, you can modify this behaviour by providing an explicit list of
admins in the [configuration](/self-hosting/guides/admin#becoming-an-admin).

27
docs/docs/self-hosting/guides/admin.md
View File

@@ -24,8 +24,31 @@ and subsequently increase the
[storage and account validity](https://github.com/ente-io/ente/blob/main/cli/docs/generated/ente_admin_update-subscription.md)
using the CLI.
For security purposes, we need to whitelist the user IDs that can perform admin
actions on the server. To do this,
> [!NOTE]
>
> The CLI command to add an account does not create Ente accounts. It only adds
> existing accounts to the list of (existing) accounts that the CLI can use.
## Becoming an admin
By default, the first user (and only the first user) created on the system is
considered as an admin.
This facility is provided as a convenience for people who are getting started
with self hosting. For more serious deployments, we recommend creating an
explicit whitelist of admins.
> [!NOTE]
>
> The first user is only treated as the admin if there are the list of admins in
> the configuration is empty.
>
> Also, if at some point you delete the first user, then you will need to define
> a whitelist to make some other user as the admin if you wish (since the first
> account has been deleted).
To whitelist the user IDs that can perform admin actions on the server, use the
following steps:
- Create a `museum.yaml` in the directory where you're starting museum from.
For example, if you're running using `docker compose up`, then this file