clones/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2024-09-22 11:07:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: server commands (#1079)

Browse Source
This commit is contained in:
Jason Rasmussen 2022-12-09 15:54:19 -05:00 committed by GitHub
parent 14889e7d85
commit 40afa3695a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 33 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/docs/FAQ.md
View File

@ -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.
### 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.

2
docs/docs/usage/_category_.json
View File

@ -1,5 +1,5 @@
{
"label": "How to use the application",
"label": "Usage",
"position": 3,
"link": {
"type": "generated-index",

25
docs/docs/usage/server-commands.md Normal file
View File

@ -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
```