immich/docs/docs/administration/server-commands.md
Dhrumil Shah 6fa685d9d8
chore: add CLI tool to the server image (#2999)
* WIP: Added immich cli tool to `immich-server` image

* WIP: Added doc entry to show it is preinstalled

* WIP: Moved immich upload cli to `immich` and default to `immich-admin`

* WIP: undid previous commit

* WIP: Updated server docs with new `immich-admin` command
2023-06-29 14:48:16 -05:00

34 lines
1.1 KiB
Markdown

# Server Commands
The `immich-server` docker image comes preinstalled with an administrative CLI (`immich-admin`) that supports the following commands:
| Command | Description |
| ------------------------ | ------------------------------------- |
| `help` | Display help |
| `reset-admin-password` | Reset the password for the admin user |
| `disable-password-login` | Disable password login |
| `enable-password-login` | Enable password login |
| `list-users` | List Immich users |
## How to run a command
To run a command, [connect](/docs/guides/docker-help.md#attach-to-a-container) to the `immich_server` container and then execute the command via `immich <command>`.
## Examples
Reset Admin Password
![Reset Admin Password](./img/reset-admin-password.png)
Disable Password Login
![Disable Password Login](./img/disable-password-login.png)
Enabled Password Login
![Enable Password Login](./img/enable-password-login.png)
List Users
![List Users](./img/list-users.png)