immich/docs
PetrSvirak 1b7e4b4e52
fix(docs): Update TrueNAS installation docs (#13017)
Mention about ACL mode added for the case when library is located in a dataset with network sharing capabilities.

Based on [community issue](https://www.truenas.com/community/threads/immich-app-permissions-to-copy-to-path-inside-smb-share.117253/) and [redit post](https://www.reddit.com/r/truenas/comments/1b1weo9/comment/l132fuj/)
2024-10-02 13:39:14 +00:00
..
blog chore(docs): change some wording (#11201) 2024-07-18 16:52:45 -04:00
docs fix(docs): Update TrueNAS installation docs (#13017) 2024-10-02 13:39:14 +00:00
src docs: hidden files cursed knowledge (#12929) 2024-09-25 16:30:01 +00:00
static chore: version v1.116.2 2024-09-27 18:17:49 +00:00
.gitignore Small docs site tweaks (#954) 2022-11-10 08:20:23 -06:00
.nvmrc chore(deps): update dependency node to v20.17.0 (#12040) 2024-08-25 22:50:51 -04:00
.prettierignore ci: doc format check (#2325) 2023-04-24 12:49:20 -05:00
.prettierrc ci: doc format check (#2325) 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 chore: more cursed knowledge (#11631) 2024-08-07 09:54:57 -04:00
package-lock.json chore(deps): update typescript-projects (#13073) 2024-10-01 11:16:34 +01:00
package.json chore(deps): update dependency node to v20.17.0 (#12040) 2024-08-25 22:50:51 -04:00
README.md docs: use npm in README (#9566) 2024-05-17 16:49:23 -04:00
sidebars.js ci: doc format check (#2325) 2023-04-24 12:49:20 -05:00
tailwind.config.js fix(deps): update typescript-projects (#11927) 2024-08-28 12:00:10 -04:00
tsconfig.json fix(deps): update docs (#7068) 2024-02-13 14:07:16 +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.