immich/docs
François-Guillaume Lemesre 38e26fd67c
chore: update Unraid Docker-Compose documentation to reflect missing healthcheck start_interval parameter from Docker Engine v24.0.9. (#10406)
* Update Unraid Docker-Compose documentation to reflect missing healthcheck start_interval parameter from Docker Engine v24.0.9.

Unraid v6.12.10 uses Docker Engine v24.0.9, which does not support setting a start_interval parameter, used by the database container. Added info to the documentation to bypass this while retaining the initial health check interval.

* Fixed Markdown formatting.

* Removed info box formatting issue.

Moved the information about Unraid's Docker Engine version to section 4 of the installation instructions, instead of trying to use an info box that broke the formatting.

* fix format

---------

Co-authored-by: Alex <alex.tran1502@gmail.com>
2024-06-17 17:08:31 +00:00
..
blog chore: update discord links (#10301) 2024-06-13 20:27:01 -04:00
docs chore: update Unraid Docker-Compose documentation to reflect missing healthcheck start_interval parameter from Docker Engine v24.0.9. (#10406) 2024-06-17 17:08:31 +00:00
src chore: update discord links (#10301) 2024-06-13 20:27:01 -04:00
static Version v1.106.4 2024-06-13 15:12:51 +00:00
.gitignore Small docs site tweaks (#954) 2022-11-10 08:20:23 -06:00
.nvmrc fix(deps): update typescript-projects (#9971) 2024-06-04 10:35:24 +01: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: update discord links (#10301) 2024-06-13 20:27:01 -04:00
package-lock.json fix(deps): update typescript-projects (#10105) 2024-06-13 20:46:26 -04:00
package.json fix(deps): update typescript-projects (#9971) 2024-06-04 10:35:24 +01: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 chore: Remove sponsor link from homepage (#9226) 2024-05-02 11:42:54 -05: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.