101 Commits

Author SHA1 Message Date
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
bo0tzz
dbd10e4704
chore: add clarifying warning to backup page (#15000)
* chore: add clarifying warning to backup page

* add extra note
2025-01-02 09:01:29 -06:00
bo0tzz
3e456dcb45
chore: add sub-path warning to reverse proxy docs (#15039) 2025-01-02 15:00:53 +00:00
Kevin Cox
95f300f8d2
docs: Add more documentation for video transcoding settings. (#13388)
Add more documentation for video transcoding settings.

This adds documentation on many of the video transcoding settings `ffmpeg.*`. I focused the documentation on values that aren't just passthough to ffmpeg settings but that are custom to Immich.
2024-12-16 11:20:33 -06:00
Matthew Momjian
345f918784
chore(docs): stronger discouraging of non-Linux installations (#14620)
* no windows!

* 2

* 3

* Update docs/docs/install/requirements.md

Co-authored-by: bo0tzz <git@bo0tzz.me>

* Update requirements.md

---------

Co-authored-by: bo0tzz <git@bo0tzz.me>
2024-12-10 16:42:45 -05:00
Tim Van Onckelen
292182fa7f
feat: Notification Email Templates (#13940) 2024-12-04 20:26:02 +00:00
Xuesong
ecb8349085
chore(docs): encode db dump in UTF-8 without BOM for Windows (#13775) 2024-11-13 10:05:53 +00:00
bo0tzz
f3e88ea2fa
docs: make IGNORE_MOUNT_CHECK warning stronger (#14011) 2024-11-08 13:29:10 +00:00
yodatak
be2b76be8c
docs: add backups to startup folders list (#13967)
Add the check of backups that is done on immich microservice of backups folder presence
2024-11-07 04:18:14 +00:00
bo0tzz
a9fc840d65
chore: tidy up backup-and-restore.md (#13961) 2024-11-06 22:18:55 +01:00
Zack Pollard
7d933ec97a
feat: built-in automatic database backups (#13773) 2024-10-31 11:29:42 +00:00
Jevgeni Kiski
e1d968d1b3
docs: note about Nginx reverse proxy compatibility with Let's Encrypt (#13764)
* Nginx reverse proxy compatibility with Let's Encrypt

* Update reverse-proxy.md

* Update reverse-proxy.md

Co-authored-by: bo0tzz <git@bo0tzz.me>

* Priority of = is higher

* Update reverse-proxy.md

---------

Co-authored-by: bo0tzz <git@bo0tzz.me>
2024-10-28 23:48:09 -05:00
polgarc
b7cd770831
docs: add warning to repair page (#13640)
* chore: remove repair docs

* add warning instead of remove
2024-10-21 14:39:28 -04:00
John Strunk
56bebd01df
chore(docs): correct two small typos (#13644) 2024-10-21 13:05:17 +00:00
ngtrio
8eb79805ae
fix(docs): typo in backup-and-restore.md (#13458) 2024-10-15 18:44:51 +00:00
martin
f29fb1655a
docs: update authelia link (#13413) 2024-10-13 21:34:38 +02:00
Jason Rasmussen
465f4639da
feat: align compose ports (#13185) 2024-10-09 16:01:52 -04:00
Joren Guillaume
1a72602ff9
docs: Add DB name to backup-and-restore (#13244)
* Update backup-and-restore.md

changelog:
Add database name to the restore command and document it in the notes

* docs: remove added database flag and change warn wording

* docs: fix forgotten warning change

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

---------

Co-authored-by: Matthew Momjian <50788000+mmomjian@users.noreply.github.com>
2024-10-09 22:37:47 +07:00
Mert
4bb42c4a25
docs: update version range for pgvecto.rs (#13231)
* update pgvecto.rs range

* clarify pg17
2024-10-06 13:16:31 -04:00
Jason Rasmussen
305fc77ebe
feat(server): better mount checks (#13092) 2024-10-01 13:04:37 -04:00
kurama
147747de32
docs: add section for Traefik Reverse Proxy (#12813)
* added a section for the Traefik Proxy

* minimized the configs

* replaced config with a comment.

* Update docs/docs/administration/reverse-proxy.md

changed timeout values

Co-authored-by: dvbthien <89862334+dvbthien@users.noreply.github.com>

* changed timeouts back to 10 minutes

* fixed typo and set default writeTimeout 600s

Leaving it at 0 may be also bad practice

* removed whitespace

* run `npm run format -- --check -w`

---------

Co-authored-by: dvbthien <89862334+dvbthien@users.noreply.github.com>
2024-09-23 14:40:23 +07:00
bo0tzz
3e12b10866
fix: remove bad examples of 'from' domain for emails (#12728)
* fix: use example.com domain for from_address_description

* fix: remove unnecessary screenshot from docs
2024-09-16 12:05:34 -04:00
Matthew Momjian
1593eaf6fc
docs: add server backup to First Steps (#12555)
* prompt for backups on setup

* add file

* case, update backup restore

* Update backup-and-restore.md

* Update backup-and-restore.md

* Update backup-and-restore.md

* Update backup-and-restore.md

* Update post-install.mdx
2024-09-11 21:27:40 -04:00
Zack Pollard
b6cad7715f
fix: docs oauth formatting issue (#12272) 2024-09-03 15:35:12 +00:00
Marco Malavolti
6bfe54788f
docs: update google oauth examples (#12162)
* Small update on oauth.md for Google Authn

* Replace "demo" with "example" to be consistent with other example
2024-08-31 13:33:17 -04:00
aviv926
5811025ebd
docs: Documentation updates (#11516)
* Documentation updates

* PR feedback

* PR feedback

* Originally implemented using #11880

* add to FAQ

* Remove mTLS

---------

Co-authored-by: Jason Rasmussen <jason@rasm.me>
2024-08-28 16:43:51 +00:00
Kenneth Bingham
2297d86569
fix(mobile): use a valid OAuth callback URL (#10832)
* add root resource path '/' to mobile oauth scheme

* chore: add oauth-callback path

* add root resource path '/' to mobile oauth scheme

* chore: add oauth-callback path

* fix: make sure there are three forward slash in callback URL

---------

Co-authored-by: Jason Rasmussen <jason@rasm.me>
Co-authored-by: Alex <alex.tran1502@gmail.com>
2024-08-28 11:30:06 -05:00
Ben
6cf5906813
docs: clarify external domain setting (#11958)
Added information about email notifications and advised users not to include a trailing slash.
2024-08-21 18:00:44 +00:00
Thariq Shanavas
fcec5f867c
chore(docs): Encode db dump in UTF-8 for windows (#11787)
* Encode db dump in UTF-8 for windows

* Update backup-and-restore.md
2024-08-14 18:01:27 -04:00
aviv926
536628ad95
docs: Add missing info to asset types and storage locations (#11358)
first
2024-07-26 08:34:36 -05:00
Dawid Rejowski
d00d33d8a5
chore(doc): small punctuation fix backup-and-restore.md (#10704)
Small punctuation fix
2024-06-30 21:59:18 -05:00
Matthew Momjian
325aa1d392
fix(docs): restart DB backup container (#10671)
Update backup-and-restore.md
2024-06-27 20:14:55 -04:00
William Brockhus
30627fe91e
chore: fix typo in jobs-workers.md (#10302) 2024-06-13 19:06:58 -04:00
aviv926
71a132b0b8
docs: Update the system settings page (#10094)
* updating

* npm run format

* fix \ > /
2024-06-11 03:52:29 -05: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
Zack Pollard
abf6fc25f7
chore: change default thumbnail concurrency and auto-detect container core count (#9981)
* feat: automatically detect amount of CPU cores and allow overriding with CPU_CORES env var

* chore: change default thumbnail concurrency to 3
2024-06-05 11:45:53 +01:00
aviv926
15474e81b2
docs: Update Authentik example (#9950)
* Update

* npm run format:fix

* more npm run format:fix
2024-06-03 10:57:09 +01: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
0fc6d69824
feat(server): user preferences (#9736)
* refactor(server): user endpoints

* feat(server): user preferences

* mobile: user preference

* wording

---------

Co-authored-by: Alex <alex.tran1502@gmail.com>
2024-05-28 09:16:53 +07:00
aviv926
e3d39837d0
docs: Add Google OAuth example (#9778)
* Add Google OAuth example

* npm run format:fix

* fix

* PR feedback

* Fix
2024-05-27 03:39:59 -04:00
Jason Rasmussen
84d824d6a7
refactor: library type (#9525) 2024-05-20 18:09:10 -04:00
Matthew Momjian
e2a31323bb
docs: add info about postgres database checksums (#9391)
* docs staging for next release

* linting

* newline

* remove old info
2024-05-13 11:23:20 +01:00
aviv926
6f82f220b8
docs: small changes&updates (#9059)
* Updates

* Adding information to the PR Checklist

* fix  #5644

* PR feedback

* suggestions

* Revert dbname
2024-05-10 23:15:38 -05:00
Matthew Momjian
13a62715e4
docs: backup restore - add warning to not backup DB_DATA_LOCATION (#9353)
backup restore add warning for backing up folder
2024-05-09 09:18:52 -05:00
Matthew Momjian
dc4f7bef69
Specify PowerShell for win backup/restore (#9262)
Update backup-and-restore.md
2024-05-04 16:23:53 -04: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
bercribe
0571901288
Fix backup and restore docker compose issue (#8939)
For the backup and restore docker compose config to work, the `POSTGRES_DB` environment variable needs to be specified
2024-04-27 00:14:51 -04:00
Mert
466451abc9
feat(server): env variable to skip migrations on startup (#9069)
* env variable to skip migrations

* update docs

* update env doc
2024-04-24 22:52:38 -04:00
Matthew Momjian
a91fd772e4
docs: default to sed pg_catalog for Linux, document restore/reset for PG bind mount (#9021)
* Update FAQ.mdx

* Update FAQ.mdx

* Update FAQ.mdx

* Update FAQ.mdx

* Update FAQ.mdx

* Update FAQ.mdx

* Update backup-and-restore.md

* Update backup-and-restore.md

* linting

* Update backup-and-restore.md

* Update FAQ.mdx

* Update backup-and-restore.md

* Update docs/docs/administration/backup-and-restore.md

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

* Update FAQ.mdx

---------

Co-authored-by: Mert <101130780+mertalev@users.noreply.github.com>
2024-04-22 18:40:19 -04:00
Alessandro Vitali
a4f805e99b
Update oauth.md (#8794)
Removed closing brackets from oauth redirect URIs.
2024-04-17 18:59:09 +00:00