0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2025-01-21 00:52:43 -05:00
immich/docs
Biepa 7c978571e0
docs: fixing example docker compose (#12230)
* Fixing example docker compose

Change needed so the following statement included in the docs a bit below makes sense:
NOTE: We have to use the `/mnt/media/christmas-trip` path and not the `/mnt/nas/christmas-trip` path since all paths have to be what the Docker containers see.

* another fix
2024-09-02 19:49:28 +00:00
..
blog chore(docs): change some wording (#11201) 2024-07-18 16:52:45 -04:00
docs docs: fixing example docker compose (#12230) 2024-09-02 19:49:28 +00:00
src docs(project): lightroom project (#12149) 2024-08-30 14:01:50 -04:00
static chore: version v1.113.0 2024-08-30 17:16:21 +00:00
.gitignore
.nvmrc chore(deps): update dependency node to v20.17.0 (#12040) 2024-08-25 22:50:51 -04:00
.prettierignore
.prettierrc
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 fix(deps): update typescript-projects (#11927) 2024-08-28 12:00:10 -04:00
package.json chore(deps): update dependency node to v20.17.0 (#12040) 2024-08-25 22:50:51 -04:00
README.md
sidebars.js
tailwind.config.js fix(deps): update typescript-projects (#11927) 2024-08-28 12:00:10 -04:00
tsconfig.json

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.