mirror of
https://github.com/immich-app/immich.git
synced 2025-05-24 01:12:58 -04:00
e39ee8a16f
* docs: Add pgadmin4 to docker-compose.yml Motivation ---------- The current documentation encourages to install pgAdmin3 on the host system. It's much simpler to add `pgAdmin4` to the `docker-compose.yml`: 1. No configuration needs to be modified, just added. 2. Better security because no additional ports need to be opened on the host. 3. Easier installation. E.g. on Archlinux there is no package pgAdmin3 anymore. 4. `pgAdmin3` does not seem to be maintained. How to test ----------- 1. Follow the documentation. 2. See if you can connect to the immich database * docs: better use separate config file I assume most users will not edit the `docker-compose.yml` and forget about `pgAdmin` once they're done. So, `pgAdmin` might get exposed to the internet with default credentials, which is not good. Better to leave a hint to change the credentials and keep the configuration separate, so users start `pgAdmin` knowingly and turn it off once they're done.
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.