Files
immich/docs
github-actions 02994883fe
Some checks failed
CLI Build / CLI Publish (push) Has been cancelled
CodeQL / Analyze (javascript) (push) Has been cancelled
CodeQL / Analyze (python) (push) Has been cancelled
Docker / pre-job (push) Has been cancelled
Docs build / pre-job (push) Has been cancelled
Static Code Analysis / pre-job (push) Has been cancelled
Static Code Analysis / zizmor (push) Has been cancelled
Test / pre-job (push) Has been cancelled
Test / ShellCheck (push) Has been cancelled
Test / OpenAPI Clients (push) Has been cancelled
Test / TypeORM Checks (push) Has been cancelled
CLI Build / Docker (push) Has been cancelled
Docker / Re-Tag ML () (push) Has been cancelled
Docker / Re-Tag ML (-armnn) (push) Has been cancelled
Docker / Re-Tag ML (-cuda) (push) Has been cancelled
Docker / Re-Tag ML (-openvino) (push) Has been cancelled
Docker / Re-Tag ML (-rknn) (push) Has been cancelled
Docker / Re-Tag ML (-rocm) (push) Has been cancelled
Docker / Re-Tag Server () (push) Has been cancelled
Docker / Build and Push ML (armnn, linux/arm64, ubuntu-24.04-arm, -armnn) (push) Has been cancelled
Docker / Build and Push ML (cpu, linux/amd64, ubuntu-latest) (push) Has been cancelled
Docker / Build and Push ML (cpu, linux/arm64, ubuntu-24.04-arm) (push) Has been cancelled
Docker / Build and Push ML (cuda, linux/amd64, ubuntu-latest, -cuda) (push) Has been cancelled
Docker / Build and Push ML (openvino, linux/amd64, ubuntu-latest, -openvino) (push) Has been cancelled
Docker / Build and Push ML (rknn, linux/arm64, ubuntu-24.04-arm, -rknn) (push) Has been cancelled
Docker / Build and Push ML (rocm, linux/amd64, mich, -rocm) (push) Has been cancelled
Docker / Merge & Push ML (armnn, -armnn) (push) Has been cancelled
Docker / Merge & Push ML (cpu) (push) Has been cancelled
Docker / Merge & Push ML (cuda, -cuda) (push) Has been cancelled
Docker / Merge & Push ML (openvino, -openvino) (push) Has been cancelled
Docker / Merge & Push ML (rknn, -rknn) (push) Has been cancelled
Docker / Merge & Push ML (rocm, -rocm) (push) Has been cancelled
Docker / Build and Push Server (linux/amd64, ubuntu-latest) (push) Has been cancelled
Docker / Build and Push Server (linux/arm64, ubuntu-24.04-arm) (push) Has been cancelled
Docker / Merge & Push Server (push) Has been cancelled
Docker / Docker Build & Push Server Success (push) Has been cancelled
Docker / Docker Build & Push ML Success (push) Has been cancelled
Docs build / Docs Build (push) Has been cancelled
Static Code Analysis / Run Dart Code Analysis (push) Has been cancelled
Test / Test & Lint Server (push) Has been cancelled
Test / Unit Test CLI (push) Has been cancelled
Test / Unit Test CLI (Windows) (push) Has been cancelled
Test / Lint Web (push) Has been cancelled
Test / Test Web (push) Has been cancelled
Test / End-to-End Lint (push) Has been cancelled
Test / Medium Tests (Server) (push) Has been cancelled
Test / End-to-End Tests (Server & CLI) (push) Has been cancelled
Test / End-to-End Tests (Web) (push) Has been cancelled
Test / Unit Test Mobile (push) Has been cancelled
Test / Unit Test ML (push) Has been cancelled
Test / .github Files Formatting (push) Has been cancelled
chore: version v1.132.3
2025-04-25 19:44:05 +00:00
..
2025-04-25 08:57:44 +00:00
2025-04-25 19:44:05 +00:00
2022-11-10 08:20:23 -06:00
2023-04-24 12:49:20 -05:00
2023-04-24 12:49:20 -05:00
2024-05-17 16:49:23 -04:00
2023-04-24 12:49:20 -05:00
2025-02-26 17:21:27 +00:00

Website

This website is built using Docusaurus, a modern static website generator.

Installation

$ npm install

Local Development

$ npm run start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true npm run deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> npm run deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.