Skip to content

Update README with improved environment variable details #208

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README with improved environment variable details #208

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions widgets/immich-stats/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
- type: custom-api
title: Immich stats
cache: 1d
url: https://${IMMICH_URL}/api/server/statistics
url: ${IMMICH_URL}/api/server/statistics
headers:
x-api-key: ${IMMICH_API_KEY}
Accept: application/json
Expand All @@ -27,5 +27,5 @@

## Environment variables

- `IMMICH_URL` - the URL of the Immich server
- `IMMICH_API_KEY` - the API key of the server which can be found in `Account settings -> API keys`
- `IMMICH_URL` - The URL for your immich server, including port but without trailing slash, e.g.: 'http://192.168.1.2:2283', or 'https://immich.example.com'
- `IMMICH_API_KEY` - the API key of the server which can be found in `Account settings -> API keys`. Permissions required: `server.statistics`