Add Immich
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- Half a day
- Newbie friendliness
- 75/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- javascript, node.js
- Domain
- api
Research direction
Read docs/ADDING_APPS.md, then look at the gitea entry in src/catalog/apps/batch-19.js as a template for the url field and the header-based key. Confirm the Immich base URL, the x-api-key header and GET /users/me against https://immich.app/docs/api/, and add the definition to the best-fitting file in src/catalog/apps/. Done when npm run validate and npm test pass and the logo is generated with npm run logos -- immich.
Written by the indexing model from the issue text.
Description
Add Immich to the catalog. It's a popular self-hosted app and a good first contribution: Conector already supports apps on your own server through a url field.
API documentation: https://immich.app/docs/api/
What we know so far (check it against the docs before relying on it):
- Base URL:
{url}/api, where{url}is a field withformat: "url"(see thegiteaapp insrc/catalog/apps/batch-19.jsfor an example). - Authentication: An API key (Account settings → API keys), sent in the
x-api-keyheader. - Connection test:
GET /users/mereturns the signed-in user. - What agents could do with it: Search photos, list albums, create albums and share links.
How to add it
- Follow docs/ADDING_APPS.md: add the definition to the most fitting file in
src/catalog/apps/, with help text that leads people to the key in a few numbered steps. - Run
npm run validateandnpm test, and generate the logo withnpm run logos -- <app id>. - If you run Immich yourself, connect it in a local Conector and try a couple of requests from your agent. Say in the pull request what you tested.
Comment here if you'd like to take it, so nobody else starts the same work.
- Dominant language
- JavaScript
- Stars
- 1
- Forks
- 1
- Avg merge
- 1h 50m
- Merged PRs (30d)
- 21
Getting set up
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Secra-Solutions/Conector
-
Add AudiobookshelfPossibly taken @masyarakatai claimed this 3 days ago. Openapp request good first issue help wanted self-hosted app
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Secra-Solutions/Conector#15 · 1 comment ·
Maintainers usually reply within 1 day
-
Add BookStackPossibly taken @masyarakatai claimed this 3 days ago. Openapp request good first issue help wanted self-hosted app
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Secra-Solutions/Conector#14 · 1 comment ·
Maintainers usually reply within 1 day
-
app request good first issue help wanted self-hosted app
Difficulty 2/5 Half a day Newbie friendliness 72/100
Secra-Solutions/Conector#13 ·
Maintainers usually reply within 1 day
-
app request good first issue help wanted self-hosted app
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
All issues in Secra-Solutions/Conector
Similar issues
-
area: right sidebar
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
zulip/zulip#40449 · 3 comments ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
DietrichGebert/ponytail#1206 ·
Maintainers usually reply within 2 days
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
bitwarden/clients#24012 · 2 comments · 1 reaction ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 80/100