1
0
mirror of https://github.com/immich-app/immich.git synced 2024-12-01 09:51:16 +02:00
Commit Graph

311 Commits

Author SHA1 Message Date
Mert
50c7b35291
clarified openapi use (#3149) 2023-07-07 20:49:18 -05:00
Dhrumil Shah
d9e084706f
chore(docs): clarifications to --import flag on CLI docs (#2996)
* Clarifications to `--import` flag on CLI docs

* WIP: Fixed heading, added some more info

* PR: fixing format issues
2023-07-01 13:33:04 -05:00
Alex Tran
55e7893bad docs: type 2023-07-01 13:30:59 -05:00
Friso Smit
604b10778c
Add more detail to reverse proxy docs (#2841)
* Add more detail to reverse proxy docs

Document fix for issue #2564

* Add port to the proxy_pass example
2023-07-01 13:30:19 -05:00
Alex Tran
ca1b9bf7b3 fix(doc): format 2023-06-29 14:49:23 -05:00
Dhrumil Shah
6fa685d9d8
chore: add CLI tool to the server image (#2999)
* WIP: Added immich cli tool to `immich-server` image

* WIP: Added doc entry to show it is preinstalled

* WIP: Moved immich upload cli to `immich` and default to `immich-admin`

* WIP: undid previous commit

* WIP: Updated server docs with new `immich-admin` command
2023-06-29 14:48:16 -05:00
bo0tzz
058c62b111
feat(blog): Make blog public, add June 2023 update post (#2935)
* feat(blog): Add blog link to website header

* feat(blog): June 2023 update post

* chore(blog): Reorder folder structure

* chore(blog): Add discord link

* chore(blog): Formatting

* chore(blog): Use youtube embeds

* fix format

---------

Co-authored-by: alex <alex@pop-os.localdomain>
2023-06-24 22:02:39 -05:00
Alex Tran
294955db17 wording 2023-06-23 23:32:39 -05:00
Alex
752ad2d2eb
chore(docs): ReadOnly documentation (#2925)
* update

* update

* update'

* update

* update

* update

* update

* chore: typoes etc

* update

* prettier

---------

Co-authored-by: bo0tzz <git@bo0tzz.me>
2023-06-23 21:06:52 -05:00
Stavros Kois
cc45564d84
move public msg to general section (#2864) 2023-06-19 16:42:59 -05:00
Stavros Kois
93c35efe67
[docs]: Document environment variables (#2814)
* draft env vars

* remove mapbox refs, fixes #2535

* formatting and add some notes

* add examples for redis and typesense url

* [skipci] add note for redis socket

* do some formatting

* update md

* fix url

* fix variable

* add web for NODE_ENV

* fix variable name

* Apply suggestions from code review

Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>

* address review feedback

* Update docker/example.env

Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>

* add section for docker compose envs

---------

Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
2023-06-19 15:55:12 -05:00
renovate[bot]
5387048dc3
fix(deps): update dependency tailwindcss to v3.3.2 (#2808)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-06-16 17:14:29 +00:00
renovate[bot]
6930df71cf
fix(deps): update dependency docusaurus-preset-openapi to v0.6.4 (#2800)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-06-16 11:40:04 -05:00
renovate[bot]
52bbf6da5d
fix(deps): update dependency url to v0.11.1 (#2802)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-06-16 11:39:54 -05:00
renovate[bot]
74429798e2
fix(deps): update dependency autoprefixer to v10.4.14 (#2799)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-06-16 11:39:25 -05:00
renovate[bot]
c8ff07fff0
fix(deps): update dependency postcss to v8.4.24 (#2801)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-06-16 11:16:44 -05:00
renovate[bot]
441ee2ef90
chore(deps): update dependency typescript to v5 (#2795)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-06-16 10:43:40 -05:00
renovate[bot]
acad133e3a
chore(deps): update dependency @tsconfig/docusaurus to v1.0.7 (#2793)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-06-16 15:30:14 +00:00
phillibl
377cec9fb1
Update xmp-sidecars.md (#2785)
Fixed a spelling mistake
2023-06-16 09:42:49 -05:00
Evan
747afa0cee
Fix trailing slash in server address while using docker (#2704) 2023-06-09 09:24:13 -05:00
Jason Rasmussen
8ebac41318
refactor(server)*: tsconfigs (#2689)
* refactor(server): tsconfigs

* chore: dummy commit

* fix: start.sh

* chore: restore original entry scripts
2023-06-08 10:01:07 -05:00
wittymap
c92c442356
Update restore example to address SQL errors on database import. (#2663) 2023-06-05 08:56:39 -05:00
Stormrover
9f2b5ea86e
Allow docker image version pinning (#2617)
* Allow docker image version pinning

* Updating docker-compose documentation.

* Fixing formatting

* Added Optional to documentation.
2023-05-30 20:53:24 -05:00
Alex Phillips
7c1dae918d
feat(server): xmp sidecar metadata (#2466)
* initial commit for XMP sidecar support

* Added support for 'missing' metadata files to include those without sidecar files, now detects sidecar files in the filesystem for media already ingested but the sidecar was created afterwards

* didn't mean to commit default log level during testing

* new sidecar logic for video metadata as well

* Added xml mimetype for sidecars only

* don't need capture group for this regex

* wrong default value reverted

* simplified the move here - keep it in the same try catch since the outcome is to move the media back anyway

* simplified setter logic

Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>

* simplified logic per suggestions

* sidecar is now its own queue with a discover and sync, updated UI for the new job queueing

* queue a sidecar job for every asset based on discovery or sync, though the logic is almost identical aside from linking the sidecar

* now queue sidecar jobs for each assset, though logic is mostly the same between discovery and sync

* simplified logic of filename extraction and asset instantiation

* not sure how that got deleted..

* updated code per suggestions and comments in the PR

* stat was not being used, removed the variable set

* better type checking, using in-scope variables for exif getter instead of passing in every time

* removed commented out test

* ran and resolved all lints, formats, checks, and tests

* resolved suggested change in PR

* made getExifProperty more dynamic with multiple possible args for fallbacks, fixed typo, used generic in function  for better type checking

* better error handling and moving files back to positions on move or save failure

* regenerated api

* format fixes

* Added XMP documentation

* documentation typo

* Merged in main

* missed merge conflict

* more changes due to a merge

* Resolving conflicts

* added icon for sidecar jobs

---------

Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
2023-05-24 20:59:30 -05:00
Jason Rasmussen
f984be8ea0
docs: update contributing pages (#2503) 2023-05-20 20:46:09 -05:00
Alex Tran
829defbf61 docs: update RAM requirement 2023-05-18 15:04:21 -05:00
Jason Rasmussen
2fc8a0db92
docs: add new features (#2441)
* chore: add new features

* Add facial recognition to docs site

* Added partner sharing to the docs site

* update developer docs

---------

Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
2023-05-18 09:48:43 -05:00
Jason Rasmussen
3ec74444b0
docs: remove roadmap link (#2442) 2023-05-15 18:25:46 +00:00
Alex
d25ddfc46b
chore: update screenshots for readme and docs (#2425)
* update screenshot

* better quality for docs
2023-05-10 23:33:32 -05:00
Jason Rasmussen
c956eee919
chore: fix backup dumper formatting (#2414) 2023-05-09 13:44:50 -05:00
Skyler Mäntysaari
54b4f8afbd
chore(docs): Update FAQ on how to disable typsense and ml (#2384) 2023-05-06 07:43:24 -05:00
Jason Rasmussen
59d93138d3
fix: linting (#2353) 2023-04-28 21:10:20 -05:00
Covalent
b21c99eb12
add auto postgress dump docs (#2349)
* add auto postgress dump docs

* add link to repo for auto db dumps

---------

Co-authored-by: Luke McCarthy <mail@lukehmcc.com>
2023-04-28 15:22:00 -05:00
Jason Rasmussen
82af2c5717
docs: backup and restore (#2326) 2023-04-24 21:14:21 -05:00
Jason Rasmussen
4cdc59e51c
ci: doc format check (#2325)
* ci: doc format check

* chore: linting
2023-04-24 12:49:20 -05:00
Alex
14be63039f
chore(doc): update FAQ for Photo Stream on iOS (#2295) 2023-04-19 18:54:19 -05:00
David
635eee9e5e
Update in-page sample .env contents and clarify process (#2252)
* Update .env example and clarify process

Update .env contents, and add a little clarification about commands being run. On Windows, for example, you might not have wget, but you'd need to be in the directory with the docker-compose.yml and .env files to run the docker-compose up -d command successfully. (Took me a while to figure out at first)

* Fix some formatting/wording

* Put log level back in and add typesense settings to address PR comments
2023-04-16 22:53:17 -05:00
Jason Rasmussen
1f17720be2
chore: run web (only) with remote backend (#2196) 2023-04-07 20:44:56 -05:00
Mauro Molin
9076f3e69e
Fix bulk upload example commands to work with paths with spaces (#2159)
The examples commands didn't work when the result of the subcommand $(pwd) contained spaces. This commit adds the proper escaping for them to work. This change also fixes the behavior of the alias allowing the correct current directory to be passed when it is placed inside the .bashrc file.
2023-04-03 20:19:10 -05:00
Alex
8b001b87d2
chores(doc): Update documentation (#2145)
* Update app architecture with typesense

* Update readme

* Added local search

* replace diagram

* Update search page
2023-04-01 21:22:16 -05:00
Thomas
c011b06bea
docs: use correct helm chart url (#2133) 2023-03-31 05:25:53 -05:00
Jonathan Jogenfors
d2600e0ddd
Documentation: Add FAQ items for reverse proxy and rpi performance (#2070)
* Add FAQ items for reverse proxy and rpi performance

* Fix wording
2023-03-24 09:36:44 -05:00
Michel Heusschen
792a87e407
fix(nginx): x-forwarded-* headers (#2019)
* fix(nginx): x-forwarded-* headers

* change category / add link to nginx config
2023-03-22 15:46:30 -05:00
Jonathan Jogenfors
d7bfab7b13
Document cli path parameter (#2011) 2023-03-18 22:11:02 +01:00
Jonathan Jogenfors
6c8b29f326
Document fallback timezone setting (fixes #2000) (#2003)
* Update FAQ.md

* Fix typo

* Mention the extract metadata job

* Don't duplicate code
2023-03-16 12:19:35 -05:00
twitsforbrains
3a1d5de742
Document how photo dates are determined (#1978)
* Document how photo dates are determined

* missing word
2023-03-14 14:12:42 -05:00
Dragos Rotaru
63ad802013
fix(docs): added note on scope of redis optional parameters in example.env (#1974) 2023-03-11 06:41:08 -06:00
Alex
8bcb2558b6
chore(doc): update jobs screenshot (#1847)
* chore(doc): update jobs screenshot

* alt text
2023-02-23 10:44:00 -06:00
Alex
b8785a5b93
chore(doc): Update (#1846)
* remove non-avx info

* background app refresh

* user popup

* architecture
2023-02-23 10:14:02 -06:00
bo0tzz
857bbe3c3b
fix(docs): Tiny tweaks in unraid guide (#1772) 2023-02-16 10:01:48 -06:00
hydazz
199eb20b66
Update unraid.md (#1475) 2023-01-29 09:44:27 -06:00
bo0tzz
189bd37e71
docs: Update links to deployment files (#1405) 2023-01-27 21:26:15 -06:00
Zack Pollard
3f2513a717
feat(server): move authentication to tokens stored in the database (#1381)
* chore: add typeorm commands to npm and set default database config values

* feat: move to server side authentication tokens

* fix: websocket should emit error and disconnect on error thrown by the server

* refactor: rename cookie-auth-strategy to user-auth-strategy

* feat: user tokens and API keys now use SHA256 hash for performance improvements

* test: album e2e test remove unneeded module import

* infra: truncate api key table as old keys will no longer work with new hash algorithm

* fix(server): e2e tests (#1435)

* fix: root module paths

* chore: linting

* chore: rename user-auth to strategy.ts and make validate return AuthUserDto

* fix: we should always send HttpOnly for our auth cookies

* chore: remove now unused crypto functions and jwt dependencies

* fix: return the extra fields for AuthUserDto in auth service validate

---------

Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
2023-01-27 14:50:07 -06:00
bo0tzz
1152cd4f07
docs: Split features into new administration category (#1440)
* docs: Split features into new administration category

* docs: Add redirects for moved pages
2023-01-27 08:32:52 -06:00
Jason Rasmussen
6ea91b2dde
feat: columns on small screens (#1433) 2023-01-26 20:52:27 -06:00
Alex
d1db47ee34
chore(docs): Update funding method (#1420)
* Add liberapay to funding option

* Update info

* Update docs
2023-01-25 10:07:58 -06:00
bo0tzz
3b1f27b674
docs(install): Add kubernetes deployment documentation (#1418)
* docs: Make some room in sidebar ordering

* docs(install): Add kubernetes deployment documentation
2023-01-25 10:07:25 -06:00
bo0tzz
50c36068e7
build: Add workflow for creating draft releases (#1402)
* build: Change pump-version script to use flags

* build: Create initial prepare-release workflow

* build: Fix release script path

* build: Rename .env.example to example.env

* docs: propagate example.env rename

* build: Fix pump-version script patch argument

* build: Final tweaks to release scripts
2023-01-24 09:26:58 -06:00
bo0tzz
9987e3bcef
docs(cli): Clarify CLI-in-docker instructions (#1395)
* docs(cli): Clarify CLI-in-docker instructions

* docs(cli): Add more example commands

* docs(cli): Add port to example command

* docs(cli): Really fix the server port this time
2023-01-23 12:41:30 -06:00
Chipwingg
83271bb11e
Fixed grammatical mistake (#1390) 2023-01-22 21:21:58 -06:00
Alex
b07891089f
feat(web/server) Add more options to public shared link (#1348)
* Added migration files

* Added logic for shared album level

* Added permission for EXIF

* Update shared link response dto

* Added condition to show download button

* Create and edit link with new parameter:

* Remove deadcode

* PR feedback

* More refactor

* Move logic of allow original file to service

* Simplify

* Wording
2023-01-21 22:15:16 -06:00
hydazz
05b79eb77b
Update all-in-one.md (#1379)
@martabal has removed his repo and moved to working on the imagegenius immich repo,
2023-01-21 20:18:53 -06:00
Jason Rasmussen
adacfb1110
feat(cli): list users (#1341) 2023-01-16 18:31:46 -06:00
Jason Rasmussen
177cc3d7f9
chore(docs): watchtower warning (#1342) 2023-01-16 18:30:50 -06:00
Jason Rasmussen
1e2f02613f
refactor: reset admin password (#1335)
* refactor: reset-admin-password

* chore: docs
2023-01-16 12:09:04 -06:00
Jason Rasmussen
67c52c3764
chore(docs): contributing (#1311)
* chore(server): linting

* chore: contributing pr checklist
2023-01-12 08:44:11 -06:00
Jason Rasmussen
b597cd891b
docs: community all in one (#1301) 2023-01-11 09:49:39 -06:00
Alex Tran
d1d69bfaf4
chore(doc) update api key usage for CLI tool 2023-01-10 13:06:36 -06:00
Jason Rasmussen
bd838a71d1
feat(web,server): disable password login (#1223)
* feat(web,server): disable password login

* chore: unit tests

* chore: fix import

* chore: linting

* feat(cli): server command for enable/disable password login

* chore: update docs

* feat(web): confirm dialogue

* chore: linting

* chore: linting

* chore: linting

* chore: linting

* chore: linting

* chore: fix web test

* chore: server unit tests
2023-01-09 16:32:58 -05:00
John P
4ff92d739d
Docs: Github -> GitHub (#1221) 2022-12-29 22:45:25 -06:00
Jason Rasmussen
6974d4068b
feat(server): mobile oauth with custom scheme redirect uri (#1204)
* feat(server): support providers without support for custom schemas

* chore: unit tests

* chore: test mobile override

* chore: add details to the docs
2022-12-29 14:47:30 -06:00
Kuljit Uppal
7810dd1942
chore(docs) Add link to releases (#1195)
Include link to Github releases page in updating instructions.
2022-12-28 09:49:34 -06:00
Alex Tran
4545249fa3
Update docs and readme 2022-12-27 14:28:25 -06:00
Jason Rasmussen
7dc12dea1e
feat(web,server): link/unlink oauth account (#1154)
* feat(web,server): link/unlink oauth account

* chore: linting

* fix: broken oauth callback

* fix: user core bugs

* fix: tests

* fix: use user response

* chore: update docs

* feat: prevent the same oauth account from being linked twice

* chore: mock logger
2022-12-26 09:35:52 -06:00
Alex Tran
443182c879
Update font size of landing page on mobile 2022-12-22 11:12:37 -06:00
Alex
452bd04272
chore(docs) revamp landing page (#1161)
* Added tailwind

* Finished styling
2022-12-22 10:31:31 -06:00
Jason Rasmussen
da9c961fca
chore(docs): FAQs, geocoding, jobs, search, and user settings (#1160) 2022-12-22 10:31:17 -06:00
Jason Rasmussen
feaf21373a
chore(docs): fix build errors (#1156) 2022-12-21 15:33:18 -06:00
Jason Rasmussen
752b267399
chore(docs): refactor pages (#1144)
* chore(docs): refactor pages

* fix: links

* fix: broken link

* refactor: post install steps using partials
2022-12-21 15:01:50 -06:00
bt90
354593a70d
Improve TensorFlow docs (#1138)
* Improve grep

* Machine learning is optional

* Improved wording

* Clarify how to remove
2022-12-20 10:27:41 -06:00
Alex
e824b55c20
Update post-installation.md 2022-12-20 09:09:26 -06:00
Alex
6d09cb6b6d
Update docs and readme 2022-12-20 08:54:52 -06:00
Matt Farrell
2d2b9a2ac9
Update instructions for Unraid (#1131) 2022-12-19 23:00:16 -06:00
Alex
42e57547f7
Update readme and docs 2022-12-19 13:34:44 -06:00
Jason Rasmussen
5a792cc821
chore(docs): spelling (#1081) 2022-12-09 18:39:50 -05:00
Jason Rasmussen
40afa3695a
docs: server commands (#1079) 2022-12-09 14:54:19 -06:00
Jason Rasmussen
5e680551b9
feat(server,web): migrate oauth settings from env to system config (#1061) 2022-12-09 14:51:42 -06:00
Matt
b8e26a2112
unraid guide no longer external (#1074)
Co-authored-by: Matt Farrell <mfarrell@squareup.com>
2022-12-08 09:54:06 -06:00
bo0tzz
a97b761eda
Add generated openapi docs to website (#1067)
* Add generated openapi docs to website

* Uppercase API link in navbar

* fix(docs): open api empty summary (#1069)

* feat(docs): Use /docs/api path for swagger docs

* Sync api version to be the same as the server

* Update version

Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
2022-12-07 21:57:34 -06:00
Alex
a9320f06e8
Added v1.36 release note to website 2022-11-21 12:53:25 -06:00
Alex Tran
37a4f4a39f Update redirect picture in documentation 2022-11-20 14:18:53 -06:00
Alex
b3e51cc849
feat(mobile) Add OAuth Login On Mobile (#990)
* Added return type for oauth/callback

* Remove console.log

* Redirect app

* Wording

* Added loading state change

* Added OAuth login on mobile

* Return correct status for  correct redirection

* Auto discovery OAuth Login
2022-11-20 11:43:10 -06:00
Brandon Rothweiler
83e2cabbcc
Update contribution-guidelines.md (#985) 2022-11-16 23:30:58 -06:00
Alex
7de7619fd1
Update contribution-guidelines.md 2022-11-16 23:15:26 -06:00
Jason Rasmussen
909e4820d6
chore(web,mobile): update github repo url (#974) 2022-11-15 20:30:44 -06:00
Jason Rasmussen
d3c35ec9c5
feat(server,web): OIDC Implementation (#884)
* chore: merge

* feat: nullable password

* feat: server debugger

* chore: regenerate api

* feat: auto-register flag

* refactor: oauth endpoints

* chore: regenerate api

* fix: default scope configuration

* refactor: pass in redirect uri from client

* chore: docs

* fix: bugs

* refactor: auth services and user repository

* fix: select password

* fix: tests

* fix: get signing algorithm from discovery document

* refactor: cookie constants

* feat: oauth logout

* test: auth services

* fix: query param check

* fix: regenerate open-api
2022-11-14 20:24:25 -06:00
Alex
277af33ab0
Update automatic-backup.md
Fixed incorrect sentence idea
2022-11-10 22:44:04 -06:00
Alex
739bed737e
Added database migration info to docs 2022-11-10 09:30:32 -06:00
bo0tzz
a1a7e6ac06
Small docs site tweaks (#954)
* Add yarn.lock to .gitignore

* Tweak announcementBar message

* Add demo link to docs homepage

* chore(docs): logo-meaning page cleanup

* chore(docs): support page cleanup

* chore(docs): tech-stack page cleanup

* chore(docs): requirements page cleanup

* Update main README warning to match docs site

* Add clearer documentation link to main README

* chore(docs): one-step-install page cleanup

* chore(docs): Security: remove example JWT_SECRET value

* chore(docs): recommended-install page cleanup

* chore(docs): portainer-install page cleanup

* chore(docs): unraid-install page cleanup
2022-11-10 08:20:23 -06:00
Alex
9057e4b7d0
Update documentation 2022-11-08 14:22:42 -06:00
Coyote6705
948ff5530c
Grammar and syntax edits for the new docs (#936)
* Update introduction.mdx

* Update logo-mearning.md

* Update support-the-project.md

Fixing more grammar/syntax :)

* Update one-step-installation.md

* Update recommended-installation.md

* Update requirements.md

* Update automatic-backup.md

* Update bulk-upload.md

* Update post-installation.md

* Update update.md

* Update contribution-guidelines.md
2022-11-06 21:27:14 -06:00
Alex Tran
bbe820d797 Switched hero image to webp 2022-11-05 20:42:26 -05:00
Alex
8b39a1da00
chore: Update repo readme (#927) 2022-11-04 15:50:26 -05:00
Alex Tran
2782dae518
doc: Added contribution guide line 2022-11-03 22:26:09 -05:00
Alex
0f9c2f0a38
doc: Add content for usage section (#922) 2022-11-03 21:42:24 -05:00
Alex
32e79ce7b3
Update portainer-installation.md 2022-11-02 09:53:39 -05:00
Alex
a898610f13
docs: add installation section (#912)
* Implemented requirements

* Added one-step installation

* Finished section
2022-11-01 20:01:03 -05:00
Alex
3cf85bb837
doc/update overview section (#904)
* Update overview section

* fix typo

* logomeaning

* Update introduction content

* Update introduction content

* Update suport the project

* typo

* Added linked information

* Finished overview section
2022-10-31 06:37:36 -05:00
Alex Tran
9614da6238
Update documentation path name 2022-10-27 22:37:27 -05:00
Alex Tran
0164171cad
Fixex routing 2022-10-27 22:03:37 -05:00
Alex Tran
8e78160bb9
Change documentation folder to docs 2022-10-27 21:44:37 -05:00