60 Commits

Author SHA1 Message Date
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
Pierre Couy
c924f6c27c
docs: update custom map style guide (#11350)
* docs:Reword "Custom Map Style" guide

- Split setting a style.json in Immich and creating a style with
  Maptiler
- Make it clearer that this is the way to change tile provider

---------

Co-authored-by: Jason Rasmussen <jason@rasm.me>
2024-08-13 16:05:36 +00:00
Matthew Momjian
827136fc8b
docs: file custom location (#11413)
* file custom location

* fix microservices
2024-07-28 15:43:09 -05:00
Matthew Momjian
088eea88e0
docs: how to change PG PW (#11414)
* guide to change PG PW

* fix
2024-07-28 15:42:42 -05:00
Mert
cc1235d4aa
docs: facial recognition and general clean-up (#11106)
* add facial recognition docs, clean up existing info

* Update smart-search.md

Co-authored-by: Alex <alex.tran1502@gmail.com>

---------

Co-authored-by: Alex <alex.tran1502@gmail.com>
2024-07-14 21:08:16 -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
Raj Dave
d23aa5e8e2
fix(docs): minor grammar fix in external-library.md (#11073) 2024-07-14 02:09:28 +00:00
Adiel Tan
b2dd4e1c2b
chore(docs): correct susceptible spelling (#11029)
Edit Spelling

https://dictionary.cambridge.org/dictionary/english/susceptible
2024-07-11 17:22:28 +02:00
aviv926
84da9abcbc
docs: Add Email Notifications info (#9930)
* Add Email Notifications info

* remove spaces

* Add ` ` to smtp link

* Small fixes

* PR feedback

* npm run format:fix

* PR feedback

* update docs

* formatting

---------

Co-authored-by: Alex <alex.tran1502@gmail.com>
2024-06-09 20:07:08 +00:00
Jason Rasmussen
69d2fcb43e
refactor: asset media endpoints (#9831)
* refactor: asset media endpoints

* refactor: mobile upload livePhoto as separate request

* refactor: change mobile backup flow to use new asset upload endpoints

* chore: format and analyze dart code

* feat: mark motion as hidden when linked

* feat: upload video portion of live photo before image portion

* fix: incorrect assetApi calls in mobile code

* fix: download asset

---------

Co-authored-by: shenlong-tanwen <139912620+shalong-tanwen@users.noreply.github.com>
Co-authored-by: Zack Pollard <zackpollard@ymail.com>
2024-05-31 13:44:04 -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
Matthew Momjian
871f3ea468
fix(docs): docker version -> name in ML (#9755)
fix docker
2024-05-25 15:14:22 +00:00
Robert Schäfer
e39ee8a16f
docs: Add pgadmin4 to docker-compose.yml (#9556)
* docs: Add pgadmin4 to docker-compose.yml

Motivation
----------
The current documentation encourages to install pgAdmin3 on the host
system. It's much simpler to add `pgAdmin4` to the `docker-compose.yml`:

1. No configuration needs to be modified, just added.
2. Better security because no additional ports need to be opened on the host.
3. Easier installation. E.g. on Archlinux there is no package pgAdmin3
   anymore.
4. `pgAdmin3` does not seem to be maintained.

How to test
-----------
1. Follow the documentation.
2. See if you can connect to the immich database

* docs: better use separate config file

I assume most users will not edit the `docker-compose.yml` and forget
about `pgAdmin` once they're done. So, `pgAdmin` might get exposed to
the internet with default credentials, which is not good.

Better to leave a hint to change the credentials and keep the
configuration separate, so users start `pgAdmin` knowingly and turn it
off once they're done.
2024-05-19 07:43:40 -05:00
Jason Rasmussen
984aa8fb41
refactor(server): system config (#9517) 2024-05-15 18:58:23 -04:00
FedericoCalzoni
540e568e9d
docs: update external-library.md (#9420)
* Update external-library.md

I believe that displaying the code for both sections, even if it seems a bit repetitive, can help prevent fast readers from overlooking it

* Apply suggestions from code review

Co-authored-by: Matthew Momjian <50788000+mmomjian@users.noreply.github.com>

---------

Co-authored-by: Matthew Momjian <50788000+mmomjian@users.noreply.github.com>
2024-05-13 12:49:30 -04:00
vovchyk bratyk
e9f99673b9
docs: add custom map styles community guide (#9311)
* Create custom-map-styles.md

* add immich_map_styles_publish.png

* Update custom-map-styles.md
2024-05-07 20:17:21 +00:00
Matthew Momjian
6eb5d2e95e
docs: update custom locations and cleanup backup/restore paths (#9148)
* Create separate-storage.md

* Update separate-storage.md

* Update separate-storage.md

* Update separate-storage.md

* Update separate-storage.md

* Update separate-storage.md

* Update separate-storage.md

* Update separate-storage.md

* Update separate-storage.md

* Update separate-storage.md

* New article for docker storage on SSD

* Update separate-storage.md

* Update separate-storage.md

* In the process, found errors in backup and restore

* Update backup-and-restore.md

* Update backup-and-restore.md

* Update backup-and-restore.md

* Update custom-locations.md

* Update custom-locations.md

* Update custom-locations.md

* Update custom-locations.md

* linting
2024-04-29 09:47:07 -04:00
Matthew Momjian
3c7b8d560f
docs: update queries for descriptions (#9144)
* update queries for descriptions

* join to assets

* specify exif.

* Update database-queries.md

LEFT JOIN not needed here

* Update database-queries.md

* Update database-queries.md
2024-04-28 23:15:32 +00:00
Matthew Momjian
28d081338b
docs: update community Guide/Projects, small PG query updates (#8844)
* Update community-projects.tsx

* Update community-guides.tsx

* Update community-projects.tsx

* Update database-queries.md

* Update database-queries.md

* Update community-projects.tsx
2024-04-16 12:39:03 -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
aviv926
07716bbff7
docs: files custom locations (#8627)
* Files Custom Locations

* minimize

* Easier maintenance

* simplify information

* default .env

---------

Co-authored-by: Alex <alex.tran1502@gmail.com>
2024-04-15 12:33:04 +00:00
Matthew Momjian
3eb61a9d53
docs: DB queries cleanups (#8740)
* Update database-queries.md

* Update database-queries.md

* Update database-queries.md

* Update postgres-standalone.md
2024-04-12 03:44:35 +00:00
Matthew Momjian
e65b3a8ea0
docs: document type of checksum stored in DB (#8737)
* Update database-queries.md

* Update database-queries.md

* Update database-queries.md

---------

Co-authored-by: Alex <alex.tran1502@gmail.com>
2024-04-12 03:18:51 +00:00
Jason Rasmussen
9e122764e7
docs: community projects (#8641) 2024-04-09 07:03:25 +02:00
Matthew Momjian
933b6b67f5
feat: Improve error handling for Install Script (#8422)
* Update install.sh

* Update install.sh

* Update install.sh

* Update install.sh

* Update install.sh

* Update install.sh

* Update install.sh

* Update install.sh

* Update install.sh

* Update docs

immich-app vs immich-data

We do not actually touch the .env file

* Remove docker-compose

Docker-compose is no longer supported by Immich

* Update remote-machine-learning.md

* Update install.sh

* Update install.sh

* Update requirements.md

* Update requirements.md
2024-04-08 19:01:57 -04:00
Matthew Momjian
e1f8e96e28
docs: pg_dumpall refinements (#8546)
* Update backup-and-restore.md

* Update template-backup-script.md

* Update FAQ.mdx
2024-04-06 09:05:00 -05:00
Mert
8edc2fb46f
refactor(server): decouple generated images from image formats (#8246)
* rename

thumbnail config

update target paths, fix tests

rename to image settings

replace legacy enum

better typing

update sql

update api

remove config option

fix

* update docs

* update other thumbnail configs in migration

* keep legacy enum for now

* fix jumbled job names

* fix jumbled job names in tests

* rename thumbhash job

* rename dto

* fix tests

* preserve order

* remove unused import

* keep old fields in dto, marked deprecated

* update sql

---------

Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
2024-04-02 04:56:56 +00:00
xethlyx
3e5183606c
docs: fix typo (#8396) 2024-03-30 21:57:19 -04:00
Kirill
28ad004b01
Update remote-machine-learning.md (#8038)
* Update remote-machine-learning.md

provide an example to use cuda or another container

* Update docs/docs/guides/remote-machine-learning.md

Co-authored-by: aviv926 <51673860+aviv926@users.noreply.github.com>

* Update docs/docs/guides/remote-machine-learning.md

---------

Co-authored-by: Mert <101130780+mertalev@users.noreply.github.com>
Co-authored-by: aviv926 <51673860+aviv926@users.noreply.github.com>
2024-03-20 22:58:52 -04:00
Thariq Shanavas
7395b03b1f
fix(docs) minor security warning raised by Borg (#8075)
* Fix minor borg security warning

* Update template-backup-script.md

* removed one unnecessary step

* Clarified optional steps

* Update template-backup-script.md
2024-03-19 23:12:36 -05:00
mmomjian
bd88a241ff
docs: Update backup script example (#7734)
* Update backup script example

* Update template-backup-script.md

* Update template-backup-script.md

* Update template-backup-script.md

* Update template-backup-script.md

* Update template-backup-script.md

* Update template-backup-script.md
2024-03-13 13:08:01 -05:00
Tejpal Sahota
6c8fad4cac
docs: Update external-library.md (#7850)
Although it is written clearly directly below, showing an example of what to change for both containers makes it very clear for people who just skim the code sections.
2024-03-11 17:02:55 +00:00
markeeisner
8c3ff65402
docs: Add guide for album sync python script (#7736)
* Add guide for album sync python script

* Add newline for formatting test

* Run prettier

* fix hardcoded url and extension

* brevity

Co-authored-by: Mert <101130780+mertalev@users.noreply.github.com>

* more brevity with copy and paste facepalm

Co-authored-by: Mert <101130780+mertalev@users.noreply.github.com>

* grammar fix

Co-authored-by: Mert <101130780+mertalev@users.noreply.github.com>

---------

Co-authored-by: Mert <101130780+mertalev@users.noreply.github.com>
2024-03-11 11:55:21 -05:00
mmomjian
9b27a09131
docs: Update DB queries (#7730) 2024-03-07 23:28:51 -05:00
aviv926
7a7475ed67
docs: Update External Libraries Guide (#7723) 2024-03-07 18:49:30 -05: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
Ben McCann
a7e01bc3fe
docs: fix typo (#6739) 2024-01-29 20:57:28 -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
Jason Rasmussen
61bb52ac11
docs: diff highlighting (#6604) 2024-01-23 18:51:02 +00:00
Hiren Shah
a7768cc64d
docs: Update remove-offline-files.md (#6449)
The previous Windows Powershell script didn't work - resulted in a bunch of errors due to multiple reasons.  The revised code works as expected.
2024-01-17 11:40:33 -05:00
Jason Rasmussen
3e793c582e
docs: fix pgadmin links (#6403) 2024-01-15 17:19:41 +00:00
Thariq Shanavas
9a7f987835
fix(docs) Fix relative paths leading to broken links (#6354) 2024-01-13 14:15:32 -06: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 da63439fd212b2ddd578fb6ca860f1a8bcd0bb45.

* All in one page

* Guide - Remove Offline Files

* Guide - Remove Offline Files

* doc: updates

* chore: fix broken link

* docs: clean up database gui guide

---------

Co-authored-by: Alex <alex.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
bo0tzz
58bd9c0018
fix(docs): Use absolute path for external library guide (#6290)
* fix(docs): Use absolute path for external library guide

* fix: Cursor in screenshot
2024-01-09 09:32:30 -06:00
Thariq Shanavas
ad09896f58
feat(docs): Template script for 3-2-1 backup of the assets and database (#6026)
* Added borg template cron job

* moved script to guides section

* Mentioned db backup location in docs

* Added directions for restoring backups
2024-01-05 15:02:55 -06:00
Michael Lyon
523e7d4742
fix(docs): update broken links (#6094)
* fix(docs): update broken link

* fix(docs): change to path

* fix(docs): second broken link

---------

Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
2024-01-01 20:32:16 +00:00
Jon Howell
00771899da
fix(docs): remove inline dev inquiries (#5733)
* fix(docs): correct link; remove inline dev inquiries

* unfix relative path
2023-12-17 10:46:29 -05:00
Jon Howell
05a1283500
fix(docs): Add title for External Library guide (#5732) 2023-12-15 14:38:14 -05:00
Jon Howell
899c71f297
docs: add a walk-through guide for External Libraries (#5594)
* Add a walk-through guide for External Libraries

* Apply prettier to markdown

* Add screenshots for GUI elements

* fix format
2023-12-15 12:46:43 -06:00
Jason Rasmussen
6ae7a92e03
fix(docs): build (#5374) 2023-11-29 02:27:01 +00:00