Files
immich/docs/docs/administration/server-commands.md

69 lines
1.8 KiB
Markdown
Raw Normal View History

2022-12-09 15:54:19 -05:00
# Server Commands
The `immich-server` docker image comes preinstalled with an administrative CLI (`immich-admin`) that supports the following commands:
2022-12-09 15:54:19 -05:00
| 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 |
2023-01-16 19:31:46 -05:00
| `list-users` | List Immich users |
2022-12-09 15:54:19 -05:00
## 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-admin <command>`.
2022-12-09 15:54:19 -05:00
## Examples
Reset Admin Password
2022-12-09 15:54:19 -05:00
```
immich-admin reset-admin-password
Found Admin:
- ID=e65e6f88-2a30-4dbe-8dd9-1885f4889b53
- OAuth ID=
- Email=admin@example.com
- Name=Immich Admin
? Please choose a new password (optional) immich-is-cool
The admin password has been updated.
```
Disable Password Login
```
immich-admin disable-password-login
Password login has been disabled.
```
Enabled Password Login
```
immich-admin enable-password-login
Password login has been enabled.
```
2023-01-16 19:31:46 -05:00
List Users
```
immich-admin list-users
[
{
id: 'e65e6f88-2a30-4dbe-8dd9-1885f4889b53',
email: 'immich@example.com.com',
firstName: 'Immich',
lastName: 'Admin',
storageLabel: 'admin',
externalPath: null,
profileImagePath: 'upload/profile/e65e6f88-2a30-4dbe-8dd9-1885f4889b53/e65e6f88-2a30-4dbe-8dd9-1885f4889b53.jpg',
shouldChangePassword: true,
isAdmin: true,
createdAt: 2023-07-11T20:12:20.602Z,
deletedAt: null,
updatedAt: 2023-09-21T15:42:28.129Z,
oauthId: '',
memoriesEnabled: true
}
]
```