Jason Rasmussen
eee793bfe4
docs: add some external library notes ( #22776 )
2025-10-08 12:13:41 -04:00
Zack Pollard
37a3784d80
feat: docs.immich.app ( #21819 )
...
Co-authored-by: Jason Rasmussen <jason@rasm.me >
2025-09-25 15:54:34 +01:00
Sergey Katsubo
f5954f4c9b
chore(docs): Avoid /data in external library examples ( #21357 )
...
* Avoid /data for external libraries
* Remove mention of microservice containers
* Update docs/docs/features/libraries.md
Co-authored-by: Matthew Momjian <50788000+mmomjian@users.noreply.github.com >
---------
Co-authored-by: Matthew Momjian <50788000+mmomjian@users.noreply.github.com >
2025-08-29 10:24:21 -05:00
Jason Rasmussen
58521c9efb
feat: change default media location to /data ( #20367 )
...
* feat!: change default media location to /data
* feat: dynamically detect media location
2025-07-29 16:58:50 -04:00
Sergey Katsubo
c7fcb23a23
chore(docs): add links to custom scan interval from other sections in external library doc ( #20353 )
2025-07-28 13:42:59 +01:00
Sergey Katsubo
977d6452f6
fix(docs): library and folders minor adjustments ( #19642 )
2025-07-10 14:31:06 +00:00
Hugo
6499057b4c
docs: update instructions for external libraries ( #19080 )
...
The first step was missing—it's probably obvious for those already
familiar with Immich.
After I added the external library, no photos showed up anywhere and
all interfaces indicated that I had no photos
Eventually I found this "Scan" button, and after clicking it photos
started to appear. This is a necessary step before photos from the
library actually show up anywhere, so point it out explicitly.
2025-06-10 09:28:49 -05:00
luzpaz
b1e1362246
fix: various typos (grouped in to separate commits) ( #18177 )
2025-05-09 13:10:34 +00:00
Viharm
8723f585e0
chore(docs): clarify missing ':ro' tag in volume mount as a warning ( #16877 )
...
📝 Clarify missing ':ro' tag in volume mount as a warning
Changed description in comment of example docker compose file to clarify it as a warning that Immich may delete it, instead of sounding as if it is ok to delete.
Co-authored-by: Alex <alex.tran1502@gmail.com >
2025-03-18 16:50:59 +00:00
Jonathan Jogenfors
3af26ee94a
feat(server): library refresh go brrr ( #14456 )
...
* feat: brr
---------
Co-authored-by: mertalev <101130780+mertalev@users.noreply.github.com >
2025-03-06 16:00:18 +01:00
Jonathan Jogenfors
869839f642
feat(server): library cleanup from ui ( #16226 )
...
* feat(server,web): scan all libraries from frontend
* feat(server,web): scan all libraries from frontend
* Add button text
2025-03-02 21:29:02 -06:00
Jonathan Jogenfors
6b7a7b0cbc
feat(web): library import path onboarding ( #16229 )
2025-02-20 09:45:34 -06:00
Felix Eckhofer
4fccc09fc1
chore: fix typo in libraries.md ( #15800 )
...
Fix typo in libraries.md
2025-01-30 20:34:12 -06:00
Alex
6239365f68
chore(docs): clean up and add new content ( #15003 )
...
* wip: Install
* wip: sharing
* wip: features
* wip: features
* wip: tags and folder view
* update links
* fix: broken reference to page sections
* pr feedback
* Update docs/docs/overview/comparison.md
Co-authored-by: Daniel Dietzler <36593685+danieldietzler@users.noreply.github.com >
* webp
* webp is glory
* webp is glory
---------
Co-authored-by: Daniel Dietzler <36593685+danieldietzler@users.noreply.github.com >
2025-01-02 10:04:14 -06:00
aviv926
96e97278d3
docs: Add info about album sync&folder view ( #12371 )
...
* Album Sync
* npm run format:fix
* fix path
* info about folder view
* Sync albums
* npm run format:fix
* Add information about limitations of a property that appears in multiple albums
* npm run format:fix
* - to ->
* Update docs/docs/features/mobile-app.mdx
Co-authored-by: Daniel Dietzler <36593685+danieldietzler@users.noreply.github.com >
* Update docs/docs/features/mobile-app.mdx
Co-authored-by: Daniel Dietzler <36593685+danieldietzler@users.noreply.github.com >
---------
Co-authored-by: Alex <alex.tran1502@gmail.com >
Co-authored-by: Daniel Dietzler <36593685+danieldietzler@users.noreply.github.com >
2024-10-29 05:00:43 +00:00
Jonathan Jogenfors
b2f2be3485
refactor(server): library syncing ( #12220 )
...
* refactor: library scanning
fix tests
remove offline files step
cleanup library service
improve tests
cleanup tests
add db migration
fix e2e
cleanup openapi
fix tests
fix tests
update docs
update docs
update mobile code
fix formatting
don't remove assets from library with invalid import path
use trash for offline files
add migration
simplify scan endpoint
cleanup library panel
fix library tests
e2e lint
fix e2e
trash e2e
fix lint
add asset trash tests
add more tests
ensure thumbs are generated
cleanup svelte
cleanup queue names
fix tests
fix lint
add warning due to trash
fix trash tests
fix lint
fix tests
Admin message for offline asset
fix comments
Update web/src/lib/components/asset-viewer/asset-viewer-nav-bar.svelte
Co-authored-by: Daniel Dietzler <36593685+danieldietzler@users.noreply.github.com >
add permission to library scan endpoint
revert asset interface sort
add trash reason to shared link stub
improve path view in offline
update docs
improve trash performance
fix comments
remove stray comment
* refactor: add back isOffline and remove trashReason from asset, change sync job flow
* chore(server): drop coverage to 80% for functions
* chore: rebase and generated files
---------
Co-authored-by: Zack Pollard <zackpollard@ymail.com >
2024-09-25 18:26:19 +01:00
Biepa
7c978571e0
docs: fixing example docker compose ( #12230 )
...
* Fixing example docker compose
Change needed so the following statement included in the docs a bit below makes sense:
NOTE: We have to use the `/mnt/media/christmas-trip` path and not the `/mnt/nas/christmas-trip` path since all paths have to be what the Docker containers see.
* another fix
2024-09-02 19:49:28 +00:00
Carsten Otto
c582a841ba
fix(docs): read-only affects XMP writing ( #11823 )
...
* mention issue: read-only library vs XMP sidecars
* mention issue: read-only library vs XMP sidecars
chore: rename motionphotos to kebab-case and add new assets (#5 )
2024-08-15 15:48:21 -05:00
Matthew Momjian
8863bd4e7d
docs: cleanup external libraries ( #11099 )
...
* cleanup external libraries
* Update external-library.md
* Update external-library.md
* Update libraries.md
* Update docs/docs/features/libraries.md
Co-authored-by: Mert <101130780+mertalev@users.noreply.github.com >
* Update external-library.md
---------
Co-authored-by: Mert <101130780+mertalev@users.noreply.github.com >
2024-07-14 17:29:47 -04:00
Matthew Momjian
5ef2553bca
feat(docs): microservices be gone ( #9558 )
...
* env vars
* docs
* more info on workers
* fix
* typo
* fix bash
* typo
* service -> contianer
* worker -> workers
* updating jobs and workers
* split workers
* redis
* fix conflict
* node -> immich
* add NO_COLOR
* Update docs/docs/administration/jobs-workers.md
* chore: fix broken links now jobs page is gone
* Update environment-variables.md
* Update environment-variables.md
---------
Co-authored-by: Zack Pollard <zackpollard@ymail.com >
2024-05-30 14:25:27 +01:00
Jason Rasmussen
84d824d6a7
refactor: library type ( #9525 )
2024-05-20 18:09:10 -04:00
Ben McCann
b1ca5455b5
docs: remove mention of external assets being read-only ( #9465 )
2024-05-14 11:02:26 +01:00
Matthew Momjian
c70d9f9055
docs: bunch of small changes ( #8854 )
...
* Update postgres-standalone.md
* Update postgres-standalone.md
* Update postgres-standalone.md
* Update postgres-standalone.md
* Update environment-variables.md
* Update postgres-standalone.md
* Update docker-compose.mdx
* Update environment-variables.md
* Update FAQ.mdx
* Update kubernetes.md
* Update kubernetes.md
* Update system-settings.md
* Update libraries.md
* Update supported-formats.md
2024-04-16 18:58:19 -04:00
aviv926
58e516c766
Docs: minor changes ( #8814 )
...
* minor
* add image
* PR feedback
* npm run format:fix of course 4_4
* Remove what is not relevant
* pr feedback
* PR feedback
* revert npm run format
* Update docs/docs/FAQ.mdx
Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com >
* Update FAQ.mdx
---------
Co-authored-by: Alex <alex.tran1502@gmail.com >
Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com >
2024-04-16 07:26:12 +02:00
Jonathan Jogenfors
a5a27594b8
docs: admin-only library settings ( #7716 )
...
* document admin-only library settings
* renew library guide
2024-03-07 21:27:02 +00:00
Jonathan Jogenfors
4cb0f37918
chore(server): Move library watcher to microservices ( #7533 )
...
* move watcher init to micro
* document watcher recovery
* chore: fix lint
* add try lock
* use global library watch lock
* fix: ensure lock stays on
* fix: mocks
* unit test for library watch lock
* move statement to correct test
* fix: correct return type of try lock
* fix: tests
* add library teardown
* add chokidar error handler
* make event strings an enum
* wait for event refactor
* refactor event type mocks
* expect correct error
* don't release lock in teardown
* chore: lint
* use enum
* fix mock
* fix lint
* fix watcher await
* remove await
* simplify typing
* remove async
* Revert "remove async"
This reverts commit 84ab5abac4101130780+mertalev@users.noreply.github.com >
Co-authored-by: Alex Tran <alex.tran1502@gmail.com >
2024-03-07 11:36:53 -06:00
Jonathan Jogenfors
e4f32a045d
chore: remove watcher polling option ( #7480 )
...
* remove watcher polling
* fix lint
* add db migration
2024-02-28 21:20:10 +01:00
Jonathan Jogenfors
b3c7bebbd4
feat(server,web) Semantic import path validation ( #7076 )
...
* add library validation api
* chore: open api
* show warning i UI
* add flex row
* fix e2e
* tests
* fix tests
* enforce path validation
* enforce validation on refresh
* return 400 on bad import path
* add limits to import paths
* set response code to 200
* fix e2e
* fix lint
* fix test
* restore e2e folder
* fix import
* use startsWith
* icon color
* notify user of failed validation
* add parent div to validation
* add docs to the import validation
* improve library troubleshooting docs
* fix button alignment
---------
Co-authored-by: Alex Tran <alex.tran1502@gmail.com >
2024-02-20 09:53:12 -06:00
Jonathan Jogenfors
068e703e88
feat(server): Automatic watching of library folders ( #6192 )
...
* feat: initial watch support
* allow offline files
* chore: ignore query errors when resetting e2e db
* revert db query
* add savepoint
* guard the user query
* chore: openapi and db migration
* wip
* support multiple libraries
* fix tests
* wip
* can now cleanup chokidar watchers
* fix unit tests
* add library watch queue
* add missing init from merge
* wip
* can now filter file extensions
* remove watch api from non job client
* Fix e2e test
* watch library with updated import path and exclusion pattern
* add library watch frontend ui
* case sensitive watching extensions
* can auto watch libraries
* move watcher e2e tests to separate file
* don't watch libraries from a queue
* use event emitters
* shorten e2e test timeout
* refactor chokidar code to filesystem provider
* expose chokidar parameters to config file
* fix storage mock
* set default config for library watching
* add fs provider mocks
* cleanup
* add more unit tests for watcher
* chore: fix format + sql
* add more tests
* move unwatch feature back to library service
* add file event unit tests
* chore: formatting
* add documentation
* fix e2e tests
* chore: fix e2e tests
* fix library updating
* test cleanup
* fix typo
* cleanup
* fixing as per pr comments
* reduce library watch config file
* update storage config and mocks
* move negative event tests to unit tests
* fix library watcher e2e
* make watch configuration global
* remove the feature flag
* refactor watcher teardown
* fix microservices init
* centralize asset scan job queue
* improve docs
* add more tests
* chore: open api
* initialize app service
* fix docs
* fix library watch feature flag
* Update docs/docs/features/libraries.md
Co-authored-by: Daniel Dietzler <36593685+danieldietzler@users.noreply.github.com >
* fix: import right app service
* don't be truthy
* fix test speling
* stricter library update tests
* move fs watcher mock to external file
* subscribe to config changes
* docker does not need polling
* make library watch() private
* feat: add configuration ui
---------
Co-authored-by: Daniel Dietzler <36593685+danieldietzler@users.noreply.github.com >
Co-authored-by: Alex Tran <alex.tran1502@gmail.com >
2024-01-31 08:15:54 +00:00
Jonathan Jogenfors
f6afb23d56
docs(server): Fix glob pattern in library exclusions ( #6752 )
...
fix glob pattern in library exclusions
2024-01-30 07:57:22 -05:00
aviv926
19d4c5e9f7
docs: Update documentation ( #6430 )
...
* Documentation corrections
* fix import
* add firewall note
* npm run format:fix
* fixs
* npm run format:fix
* space
* fix note
* admin-jobs.png image update + fixes
* Storage Template.md update
* Add new Troubleshooting about symbolic link in library
* Updating the libraries.md
* Updating the libraries.md
* Corrections
* add `/`
* ...
* Add Python script to remove-offline-files.md
* npm run format:fix
* Add info about HDR in FAQ
* My wrong merge
* add info about symlink
* [Community] + PowerShell
* add 360 photo support to Features in README
* add info about remote ML and info about orphaned files from the external library to the scripts page
* Typo
* add note about storage locations
* add info about Purge for portainer and link to info about asset types and storage locations
* npm run format:fix
* Add FAQ about "faces" that aren't faces
* Update docs/docs/administration/backup-and-restore.md
* Update docs/docs/administration/backup-and-restore.md
---------
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com >
2024-01-25 17:17:38 +00:00
aviv926
df4af025d7
Edit and update of FAQ+new database GUI guide ( #5958 )
...
* Update added and re -arrangement of FAQ
* Erasure of addition mistakes
* Erasure of addition mistakes
* Fix broken links
* Correcting spelling errors + adding more questions
* New required fixes
* More FAQ
* Adding questions + adding a note about a directory and an explanation about adding a path in a Windows environment
* Update docs/docs/FAQ/Albums-FAQ.md
Co-authored-by: Mert <101130780+mertalev@users.noreply.github.com >
* Update docs/docs/FAQ/Assets-FAQ.md
Co-authored-by: Mert <101130780+mertalev@users.noreply.github.com >
* Update docs/docs/FAQ/Machine-Learning-FAQ.md
Co-authored-by: Mert <101130780+mertalev@users.noreply.github.com >
* Update docs/docs/FAQ/Machine-Learning-FAQ.md
Co-authored-by: Mert <101130780+mertalev@users.noreply.github.com >
* Update docs/docs/features/libraries.md
Co-authored-by: Mert <101130780+mertalev@users.noreply.github.com >
* Corrections
* chore: updates
* import TOCinlines from all FAQ pages to one page + Corrections
* Removing privacy information + adding required Flutter version information
* Removing privacy information + adding required Flutter version information
* Revert "Removing privacy information + adding required Flutter version information"
This reverts commit da63439fd2alex.tran1502@gmail.com >
Co-authored-by: Mert <101130780+mertalev@users.noreply.github.com >
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com >
2024-01-12 14:45:41 -05:00
Graham Steffaniak
a1523a9af0
docs: Update libraries.md ( #6333 )
2024-01-11 17:10:48 -05:00
bo0tzz
ac0cb4a96e
Revert "docs: add step by step set up guide for external libraries ( #5288 )" ( #6194 )
...
This reverts commit 27be076958
2024-01-05 09:45:50 -06:00
jcianci12
27be076958
docs: add step by step set up guide for external libraries ( #5288 )
...
* Update libraries.md - External Library step by step set up guide added
When setting up immmich external libraries, I found some missing details around the relationship between external paths and import paths. By providing an example, I am hoping it helps new users.
* chore: fix formatting
---------
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com >
2024-01-01 22:18:28 -05:00
Ploonet
98f1e85c87
fix(docs): Typo in libraries exclusion pattern ( #4972 )
...
Co-authored-by: Antony Mota <amota.confluenceconseil@boiron.fr >
2023-11-12 09:49:47 -05:00
Mayuresh Dharwadkar
c77ba46d60
docs: fix typos ( #4713 )
2023-10-30 09:17:10 -05:00
Jonathan Jogenfors
b56f22aac3
docs: add troubleshooting info to libraries + minor docs tweaks ( #4377 )
...
* docs: add troubleshooting info to libraries
* fix: revert docker-compose
2023-10-09 09:13:47 -05:00
Jonathan Jogenfors
acdc66413c
feat(server,web): libraries ( #3124 )
...
* feat: libraries
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com >
Co-authored-by: Alex <alex.tran1502@gmail.com >
2023-09-20 13:16:33 +02:00
