From 40afa3695ae981c42daf095d5724ab2305bd6139 Mon Sep 17 00:00:00 2001 From: Jason Rasmussen Date: Fri, 9 Dec 2022 15:54:19 -0500 Subject: [PATCH] docs: server commands (#1079) --- docs/docs/FAQ.md | 8 +++++++- docs/docs/usage/_category_.json | 2 +- docs/docs/usage/server-commands.md | 25 +++++++++++++++++++++++++ 3 files changed, 33 insertions(+), 2 deletions(-) create mode 100644 docs/docs/usage/server-commands.md diff --git a/docs/docs/FAQ.md b/docs/docs/FAQ.md index 0bf8f77b39..86d7acb274 100644 --- a/docs/docs/FAQ.md +++ b/docs/docs/FAQ.md @@ -13,7 +13,13 @@ sidebar_position: 6 | ![cloud-done](/img/cloud-done.svg) | Asset was uploaded from this device and is now backed up in the cloud/server and still available in original on the device | ### How can I sync an existing directory with Immich's server? + Immich doesn't have the mechanism to sync an existing directory with the server. There is however, a helper CLI tool to help you bulk upload the existing photos and videos to the server. You can find the guide to use the CLI tool [here](/docs/usage/bulk-upload.md). ### Why doesn't Immich watch an existing photo gallery directory? -The initial approach of Immich is to become a backup tool, primarily for mobile device usage. Thus, all the assets must be uploaded from the mobile client. The app was architectured to perform that job well. \ No newline at end of file + +The initial approach of Immich is to become a backup tool, primarily for mobile device usage. Thus, all the assets must be uploaded from the mobile client. The app was architectured to perform that job well. + +### How can I reset the admin password? + +The admin password can be reset by running the [reset-admin-password](/docs/usage/server-commands) command on the immich-server. diff --git a/docs/docs/usage/_category_.json b/docs/docs/usage/_category_.json index 4e3bb19af3..ae2102d23c 100644 --- a/docs/docs/usage/_category_.json +++ b/docs/docs/usage/_category_.json @@ -1,5 +1,5 @@ { - "label": "How to use the application", + "label": "Usage", "position": 3, "link": { "type": "generated-index", diff --git a/docs/docs/usage/server-commands.md b/docs/docs/usage/server-commands.md new file mode 100644 index 0000000000..f9fdbafd3b --- /dev/null +++ b/docs/docs/usage/server-commands.md @@ -0,0 +1,25 @@ +--- +sidebar_position: 5 +--- + +# Server Commands + +The `immich-server` docker image comes preinstalled with an administrative CLI that supports the following commands: + +| Command | Description | +| ----------------------------- | ------------------------------------- | +| `immich help` | Display help | +| `immich reset-admin-password` | Reset the password for the admin user | + +## How to run a command + +To run a command, connect to the container and then execute it. For example: + +```bash +docker exec -it immich-server_1 sh + +/usr/src/app$ immich reset-admin-password +? Please choose a new password (optional) immich-is-awesome-unline-this-password +New password: +immich-is-awesome-unline-this-password +```