immich/i18n
Paul Makles 15e00f82f0
feat: maintenance mode (#23431)
* feat: add a `maintenance.enabled` config flag

* feat: implement graceful restart
feat: restart when maintenance config is toggled

* feat: boot a stripped down maintenance api if enabled

* feat: cli command to toggle maintenance mode

* chore: fallback IMMICH_SERVER_URL environment variable in process

* chore: add additional routes to maintenance controller

* fix: don't wait for nest application to close to finish request response

* chore: add a failsafe on restart to prevent other exit codes from preventing restart

* feat: redirect into/from maintenance page

* refactor: use system metadata for maintenance status

* refactor: wait on WebSocket connection to refresh

* feat: broadcast websocket event on server restart
refactor: listen to WS instead of polling

* refactor: bubble up maintenance information instead of hijacking in fetch function
feat: show modal when server is restarting

* chore: increase timeout for ungraceful restart

* refactor: deduplicate code between api/maintenance workers

* fix: skip config check if database is not initialised

* fix: add `maintenanceMode` field to system config test

* refactor: move maintenance resolution code to static method in service

* chore: clean up linter issues

* chore: generate dart openapi

* refactor: use try{} block for maintenance mode check

* fix: logic error in server redirect

* chore: include `maintenanceMode` key in e2e test

* chore: add i18n entries for maintenance screens

* chore: remove negated condition from hook

* fix: should set default value not override in service

* fix: minor error in page

* feat: initial draft of maintenance module, repo., worker controller, worker service

* refactor: move broadcast code into notification service

* chore: connect websocket on client if in maintenance

* chore: set maintenance module app name

* refactor: rename repository to include worker
chore: configure websocket adapter

* feat: reimplement maintenance mode exit with new module

* refactor: add a constant enum for ExitCode

* refactor: remove redundant route for maintenance

* refactor: only spin up kysely on boot (rather than a Nest app)

* refactor(web): move redirect logic into +layout file where modal is setup

* feat: add Maintenance permission

* refactor: merge common code between api/maintenance

* fix: propagate changes from the CLI to servers

* feat: maintenance authentication guard

* refactor: unify maintenance code into repository
feat: add a step to generate maintenance mode token

* feat: jwt auth for maintenance

* refactor: switch from nest jwt to just jsonwebtokens

* feat: log into maintenance mode from CLI command

* refactor: use `secret` instead of `token` in jwt terminology
chore: log maintenance mode login URL on boot
chore: don't make CLI actions reload if already in target state

* docs: initial draft for maintenance mode page

* refactor: always validate the maintenance auth on the server

* feat: add a link to maintenance mode documentation

* feat: redirect users back to the last page they were on when exiting maintenance

* refactor: provide closeFn in both maintenance repos.

* refactor: ensure the user is also redirected by the server

* chore: swap jsonwebtoken for jose

* refactor: introduce AppRestartEvent w/o secret passing

* refactor: use navigation goto

* refactor: use `continue` instead of `next`

* chore: lint fixes for server

* chore: lint fixes for web

* test: add mock for maintenance repository

* test: add base service dependency to maintenance

* chore: remove @types/jsonwebtoken

* refactor: close database connection after startup check

* refactor: use `request#auth` key

* refactor: use service instead of repository
chore: read token from cookie if possible
chore: rename client event to AppRestartV1

* refactor: more concise redirect logic on web

* refactor: move redirect check into utils
refactor: update translation strings to be more sensible

* refactor: always validate login (i.e. check cookie)

* refactor: lint, open-api, remove old dto

* refactor: encode at point of usage

* refactor: remove business logic from repositories

* chore: fix server/web lints

* refactor: remove repository mock

* chore: fix formatting

* test: write service mocks for maintenance mode

* test: write cli service tests

* fix: catch errors when closing app

* fix: always report no maintenance when usual API is available

* test: api e2e maintenance spec

* chore: add response builder

* chore: add helper to set maint. auth cookie

* feat: add SSR to maintenance API

* test(e2e): write web spec for maintenance

* chore: clean up lint issues

* chore: format files

* feat: perform 302 redirect at server level during maintenance

* fix: keep trying to stop immich until it succeeds (CLI issue)

* chore: lint/format

* refactor: annotate references to other services in worker service

* chore: lint

* refactor: remove unnecessary await

Co-authored-by: Daniel Dietzler <36593685+danieldietzler@users.noreply.github.com>

* refactor: move static methods into util

* refactor: assert secret exists in maintenance worker

* refactor: remove assertion which isn't necessary anymore

* refactor: remove assertion

* refactor: remove outer try {} catch block from loadMaintenanceAuth

* refactor: undo earlier change to vite.config.ts

* chore: update tests due to refactors

* revert: vite.config.ts

* test: expect string jwt

* chore: move blanket exceptions into controllers

* test: update tests according with last change

* refactor: use respondWithCookie
refactor: merge start/end into one route
refactor: rename MaintenanceRepository to AppRepository
chore: use new ApiTag/Endpoint
refactor: apply other requested changes

* chore: regenerate openapi

* chore: lint/format

* chore: remove secureOnly for maint. cookie

* refactor: move maintenance worker code into src/maintenance\nfix: various test fixes

* refactor: use `action` property for setting maint. mode

* refactor: remove Websocket#restartApp in favour of individual methods

* chore: incomplete commit

* chore: remove stray log

* fix: call exitApp from maintenance worker on exit

* fix: add app repository mock

* fix: ensure maintenance cookies are secure

* fix: run playwright tests over secure context (localhost)

* test: update other references to 127.0.0.1

* refactor: use serverSideEmitWithAck

* chore: correct the logic in tryTerminate

* test: juggle cookies ourselves

* chore: fix lint error for e2e spec

* chore: format e2e test

* fix: set cookie secure/non-secure depending on context

* chore: format files

---------

Co-authored-by: Daniel Dietzler <36593685+danieldietzler@users.noreply.github.com>
2025-11-17 17:15:44 +07:00
..
af.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
ar.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
az.json chore(web): update translations (#22486) 2025-10-03 15:10:09 +07:00
be.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
bg.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
bi.json chore(web): update translations (#21464) 2025-09-05 19:53:36 +07:00
bn.json chore(web): update translations (#22623) 2025-10-14 16:22:42 +07:00
ca.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
cs.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
cv.json chore(web): update translations (#20449) 2025-08-21 20:48:05 +07:00
da.json chore(web): update translations (#23375) 2025-10-31 18:02:30 +07:00
de.json chore(web): update translations (#23375) 2025-10-31 18:02:30 +07:00
el.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
en.json feat: maintenance mode (#23431) 2025-11-17 17:15:44 +07:00
es.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
et.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
eu.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
fa.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
fi.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
fil.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
fr.json chore(web): update translations (#23375) 2025-10-31 18:02:30 +07:00
gl.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
he.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
hi.json chore(web): update translations (#23375) 2025-10-31 18:02:30 +07:00
hr.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
hu.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
hy.json chore(web): update translations (#20449) 2025-08-21 20:48:05 +07:00
id.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
it.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
ja.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
ka.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
kk.json chore(web): update translations (#21130) 2025-08-31 00:52:11 +07:00
kmr.json fix: weblate conflicts (#18389) 2025-05-20 13:15:10 +07:00
kn.json chore(web): update translations (#22486) 2025-10-03 15:10:09 +07:00
ko.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
lb.json chore: move weblate translations to root directory (#13604) 2024-10-22 15:39:28 +07:00
lt.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
lv.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
mfa.json chore: move weblate translations to root directory (#13604) 2024-10-22 15:39:28 +07:00
mk.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
ml.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
mn.json chore(web): update translations (#19228) 2025-07-22 10:27:32 +07:00
mr.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
ms.json chore(web): update translations (#22288) 2025-09-23 18:20:27 +07:00
nb_NO.json chore(web): update translations (#23375) 2025-10-31 18:02:30 +07:00
nl.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
nn.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
pa.json chore(web): update translations (#22623) 2025-10-14 16:22:42 +07:00
pl.json chore(web): update translations (#23375) 2025-10-31 18:02:30 +07:00
pt.json chore(web): update translations (#23375) 2025-10-31 18:02:30 +07:00
pt_BR.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
ro.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
ru.json chore(web): update translations (#23375) 2025-10-31 18:02:30 +07:00
sk.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
sl.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
sq.json chore(web): update translations (#21624) 2025-09-11 10:28:48 +07:00
sr_Cyrl.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
sr_Latn.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
sv.json chore(web): update translations (#23375) 2025-10-31 18:02:30 +07:00
ta.json chore(web): update translations (#23375) 2025-10-31 18:02:30 +07:00
te.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
th.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
tr.json chore(web): update translations (#23375) 2025-10-31 18:02:30 +07:00
uk.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
ur.json chore(web): update translations (#20449) 2025-08-21 20:48:05 +07:00
vi.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00
zh_Hant.json chore(web): update translations (#23375) 2025-10-31 18:02:30 +07:00
zh_SIMPLIFIED.json chore(web): update translations (#22937) 2025-10-30 14:40:49 +07:00