self-hosted/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2024-12-26 10:50:29 +02:00
Code Issues Releases Activity
99ccf28bc6
immich/docs
History
Matthew Momjian a91fd772e4
docs: default to sed pg_catalog for Linux, document restore/reset for PG bind mount (#9021) 
* Update FAQ.mdx

* Update FAQ.mdx

* Update FAQ.mdx

* Update FAQ.mdx

* Update FAQ.mdx

* Update FAQ.mdx

* Update backup-and-restore.md

* Update backup-and-restore.md

* linting

* Update backup-and-restore.md

* Update FAQ.mdx

* Update backup-and-restore.md

* Update docs/docs/administration/backup-and-restore.md

Co-authored-by: Mert <101130780+mertalev@users.noreply.github.com>

* Update FAQ.mdx

---------

Co-authored-by: Mert <101130780+mertalev@users.noreply.github.com>
2024-04-22 18:40:19 -04:00
..
blog feat(docs): New repair and statistics pages (#8030) 2024-03-23 19:43:10 +00:00
docs docs: default to sed pg_catalog for Linux, document restore/reset for PG bind mount (#9021) 2024-04-22 18:40:19 -04:00
src add community project PSImmich (#8851) 2024-04-16 18:01:56 +00:00
static docs: community projects (#8641) 2024-04-09 07:03:25 +02:00
.gitignore Small docs site tweaks (#954) 2022-11-10 08:20:23 -06: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 Docs: minor changes (#8814) 2024-04-16 07:26:12 +02:00
package-lock.json fix(deps): update typescript-projects (#8834) 2024-04-16 17:45:14 -04:00
package.json deps: update docs (#6462) 2024-01-17 22:44:45 -05:00
README.md Docs: minor changes (#8814) 2024-04-16 07:26:12 +02:00
sidebars.js ci: doc format check (#2325) 2023-04-24 12:49:20 -05:00
tailwind.config.js docs: add sponsor link (#5597) 2023-12-09 20:59:00 -06:00
tsconfig.json fix(deps): update docs (#7068) 2024-02-13 14:07:16 +00:00

README.md

Website

This website is built using Docusaurus, 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.