mirror of
https://github.com/immich-app/immich.git
synced 2025-12-21 04:25:30 -05:00
4be9a5ebf8
Description
-----------
The documentation lies about comments in `docker/docker-compose.dev.yml`.
Reason: in 689c6aa2762f3bf285b8eacb187888b3fd94ee13 these docs were added
but the comments in this file are removed in
b9e2590752500e54600c4df90774718d5373f462 and the docs weren't updated.
How Has This Been Tested?
-------------------------
```
$ git log -S rootless
commit b9e2590752500e54600c4df90774718d5373f462
Author: Jason Rasmussen <jason@rasm.me>
Date: Tue Sep 16 12:48:44 2025 -0400
chore: simplify (#22082)
commit 689c6aa2762f3bf285b8eacb187888b3fd94ee13
Author: Rudolf Horváth <R-Rudolf@users.noreply.github.com>
Date: Thu Nov 21 13:25:45 2024 +0100
docs: add developer notes about rootless docker setup (#13250)
```
Checklist:
----------
- [x] I have performed a self-review of my own code
- [x] I have made corresponding changes to the documentation if applicable
- [x] I have no unrelated changes in the PR.
- [ ] I have confirmed that any new dependencies are strictly necessary.
- [ ] I have written tests for new code (if applicable)
- [ ] I have followed naming conventions/patterns in the surrounding code
- [ ] All code in `src/services/` uses repositories implementations for database calls, filesystem operations, etc.
- [ ] All code in `src/repositories/` is pretty basic/simple and does not have any immich specific logic (that belongs in `src/services/`)
Website
This website is built using Docusaurus, a modern static website generator.
Installation
$ pnpm install
Local Development
$ pnpm 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
$ pnpm 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 pnpm run deploy
Not using SSH:
$ GIT_USER=<Your GitHub username> pnpm 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.