sascha
/
immich
mirror of https://github.com/immich-app/immich.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
immich/docs
History
Robert Schäfer 4be9a5ebf8
fix(docs): obsolete docs about rootless docker (#24376) 
Description
-----------

The documentation lies about comments in `docker/docker-compose.dev.yml`.

Reason: in 689c6aa276 these docs were added
but the comments in this file are removed in
b9e2590752 and the docs weren't updated.

How Has This Been Tested?
-------------------------
```
$ git log -S rootless

commit b9e2590752
Author: Jason Rasmussen <jason@rasm.me>
Date:   Tue Sep 16 12:48:44 2025 -0400

    chore: simplify (#22082)

commit 689c6aa276
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/`)
 		2025-12-03 18:34:08 +07:00
..
docs fix(docs): obsolete docs about rootless docker (#24376) 2025-12-03 18:34:08 +07:00
src feat: move community projects and guides to immich-aweseome (#23016) 2025-10-17 10:00:28 +07:00
static chore: version v2.3.1 2025-11-20 02:20:16 +07:00
.gitignore docs: include openapi.json (#20760) 2025-08-07 12:00:50 +07:00
.nvmrc chore(deps): update node.js to v24.11.1 (#24147) 2025-11-25 11:55:36 +07:00
.prettierignore
…
.prettierrc
…
README.md chore: update docs to use pnpm (#21113) 2025-08-21 15:25:05 +07:00
babel.config.js
…
docusaurus.config.js chore: remove warning banner (#22547) 2025-10-01 21:06:22 +07:00
mise.toml feat: mise monorepo tasks (#23691) 2025-11-10 15:55:15 +07:00
package.json chore(deps): update node.js to v24.11.1 (#24147) 2025-11-25 11:55:36 +07:00
sidebars.js
…
tailwind.config.js docs: fix typos (#16352) 2025-02-26 17:21:27 +07:00
tsconfig.json fix(docs): tsconfig issues in IDE (VSCode) - migrate tsconfig extends file to current docusaurus implementation (#16282) 2025-02-24 13:24:28 +07:00

README.md

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.