immich/docs
Jensen H 2496bd7514
docs: update unraid installation steps ()
Update unraid.md

Current steps omit this key step, which results in the postgresql docker complaining about the data folder not being empty. (It tries to use the `/mnt/user/appdata` folder as its application data folder.
2025-03-10 08:56:42 +00:00
..
blog chore(docs): change some wording () 2024-07-18 16:52:45 -04:00
docs docs: update unraid installation steps () 2025-03-10 08:56:42 +00:00
src docs: 60k stars! () 2025-03-05 11:40:45 -06:00
static chore: version v1.129.0 2025-03-05 19:47:50 +00:00
.gitignore Small docs site tweaks () 2022-11-10 08:20:23 -06:00
.nvmrc chore(deps): update node.js to v22.14.0 () 2025-02-15 21:29:33 -06:00
.prettierignore ci: doc format check () 2023-04-24 12:49:20 -05:00
.prettierrc ci: doc format check () 2023-04-24 12:49:20 -05:00
babel.config.js Change documentation folder to docs 2022-10-27 21:44:37 -05:00
docusaurus.config.js feat: merch links () 2025-02-02 00:26:23 +01:00
package-lock.json fix(deps): update typescript-projects () 2025-03-07 21:20:45 +00:00
package.json fix(docs): tsconfig issues in IDE (VSCode) - migrate tsconfig extends file to current docusaurus implementation () 2025-02-24 13:24:28 -06:00
README.md docs: use npm in README () 2024-05-17 16:49:23 -04:00
sidebars.js ci: doc format check () 2023-04-24 12:49:20 -05:00
tailwind.config.js docs: fix typos () 2025-02-26 17:21:27 +00:00
tsconfig.json fix(docs): tsconfig issues in IDE (VSCode) - migrate tsconfig extends file to current docusaurus implementation () 2025-02-24 13:24:28 -06: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.