mirror of
https://github.com/immich-app/immich.git
synced 2025-03-17 21:18:12 +02:00
93c35efe67
* draft env vars * remove mapbox refs, fixes #2535 * formatting and add some notes * add examples for redis and typesense url * [skipci] add note for redis socket * do some formatting * update md * fix url * fix variable * add web for NODE_ENV * fix variable name * Apply suggestions from code review Co-authored-by: Jason Rasmussen <jrasm91@gmail.com> * address review feedback * Update docker/example.env Co-authored-by: Jason Rasmussen <jrasm91@gmail.com> * add section for docker compose envs --------- Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
Website
This website is built using Docusaurus 2, a modern static website generator.
Installation
$ yarn
Local Development
$ yarn 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
$ yarn 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 yarn deploy
Not using SSH:
$ GIT_USER=<Your GitHub username> yarn 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.