[docs] Add guide to connect CLI to self-hosted instance

This commit is contained in:
Neeraj Gupta 2024-03-13 11:03:23 +05:30 committed by Neeraj Gupta
parent f7077c2b11
commit c7d7d436c3

View file

@ -17,3 +17,29 @@ configure the endpoint the app should be connecting to.
> >
> This is only supported by the Ente Auth app currently. We'll add this same > This is only supported by the Ente Auth app currently. We'll add this same
> functionality to the Ente Photos app soon. > functionality to the Ente Photos app soon.
---
# CLI
Define a config.yaml and put it either in the same directory as CLI or path defined in env variable `ENTE_CLI_CONFIG_PATH`
```yaml
endpoint:
api: "http://localhost:8080"
```
You should be able to [add an account](https://github.com/ente-io/ente/blob/main/cli/docs/generated/ente_account_add.md), 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 the admin actions, you can create `server/museum.yaml`, and whitelist add the admin userID `internal.admins`. See [local.yaml](https://github.com/ente-io/ente/blob/main/server/configurations/local.yaml#L211C1-L232C1) in the server source code for details about how to define this.
You can use [account list](https://github.com/ente-io/ente/blob/main/cli/docs/generated/ente_account_list.md) command to find the user id of any account.
```yaml
....
internal:
admins:
# - 1580559962386440
....
```