self-hosted/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2024-12-25 10:43:13 +02:00
Code Issues Releases Activity

chore(doc) update api key usage for CLI tool

Browse Source
This commit is contained in:
Alex Tran 2023-01-10 13:06:36 -06:00
parent 221e03488e
commit d1d69bfaf4
No known key found for this signature in database
GPG Key ID: E4954BC787B85C8A
2 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/docs/features/bulk-upload.md
View File

@ -20,7 +20,7 @@ npm i -g immich
Specify user's credentials, Immich's server address and port, and the directory you would like to upload videos/photos from. Specify user's credentials, Immich's server address and port, and the directory you would like to upload videos/photos from.
```bash ```bash
immich upload --email testuser@email.com --password password --server http://192.168.1.216:2283/api -d your/target/directory immich upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api -d your/target/directory
``` ```
--- ---
@ -31,26 +31,32 @@ immich upload --email testuser@email.com --password password --server http://192
| ---------------- | ------------------------------------------------------------------- | | ---------------- | ------------------------------------------------------------------- |
| --yes / -y | Assume yes on all interactive prompts | | --yes / -y | Assume yes on all interactive prompts |
| --delete / -da | Delete local assets after upload | | --delete / -da | Delete local assets after upload |
| --email / -e | User's email | | --key / -k | User's API key |
| --password / -pw | User's password |
| --server / -s | Immich's server address | | --server / -s | Immich's server address |
| --directory / -d | Directory to upload from | | --directory / -d | Directory to upload from |
| --threads / -t | Number of threads to use (Default 5) | | --threads / -t | Number of threads to use (Default 5) |
| --album/ -al | Create albums for assets based on the parent folder or a given name | | --album/ -al | Create albums for assets based on the parent folder or a given name |
### Obtain the API Key
The API key can be obtained in the user setting panel on the web interface.
![Obtain Api Key](./img/obtain-api-key.png)
### Run via Docker ### Run via Docker
Be aware that as this runs inside a container it mounts your current directory as a volume, and for the -d flag you need to use the path inside the container. Be aware that as this runs inside a container it mounts your current directory as a volume, and for the -d flag you need to use the path inside the container.
```bash ```bash
docker run -it --rm -v $(pwd):/import ghcr.io/immich-app/immich-cli:latest upload --email testuser@email.com --password password --server http://192.168.1.216:2283/api -d /import docker run -it --rm -v $(pwd):/import ghcr.io/immich-app/immich-cli:latest upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api -d /import
``` ```
Optionally, you can create an alias: Optionally, you can create an alias:
```bash ```bash
alias immich="docker run -it --rm -v $(pwd):/import ghcr.io/immich-app/immich-cli:latest" alias immich="docker run -it --rm -v $(pwd):/import ghcr.io/immich-app/immich-cli:latest"
immich upload --email testuser@email.com --password password --server http://192.168.1.216:2283/api -d /import immich upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api -d /import
``` ```
### Run from source ### Run from source
@ -68,5 +74,5 @@ npm run build
``` ```
```bash title="Run the command" ```bash title="Run the command"
node bin/index.js upload --email testuser@email.com --password password --server http://192.168.1.216:2283/api -d your/target/directory node bin/index.js upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api -d your/target/directory
``` ```

BIN
docs/docs/features/img/obtain-api-key.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 44 KiB