immich/docs/docs/installation/portainer-installation.md
Alex a898610f13
docs: add installation section ()
* Implemented requirements

* Added one-step installation

* Finished section
2022-11-01 20:01:03 -05:00

1.7 KiB

sidebar_position
4

Portainer

Install Immich using Portainer's Stack feature.

  1. Go to "Stacks" in the left sidebar.
  2. Click on "Add stack".
  3. Give the stack a name (i.e. Immich), and select "Web Editor" as the build method.
  4. Copy the content of the docker-compose.yml file from the GitHub repository
  5. Replace .env with .stack.env for all containers that need to use environment variables in the web editor.

<img src={require('./img/dot-env.png').default} width="50%" style={{border: '1px solid #ddd'}} alt="Dot Env Example" />

  1. Click on "Advanced Mode" in the Environment Variables section.

<img src={require('./img/env-1.png').default} width="50%" style={{border: '1px solid #ddd'}} alt="Dot Env Example" />

  1. Copy the content of the .env.example file from the GitHub repository and paste to the editor.
  2. Switch back to "Simple Mode".

<img src={require('./img/env-2.png').default} width="50%" style={{border: '1px solid #ddd'}} alt="Dot Env Example" />

  • Populate custom database information if necessary.
  • Populate UPLOAD_LOCATION as prefered location for storing backup assets.
  • Populate a secret value for JWT_SECRET, you can use the command below to generate a secured key
openssl rand -base64 128
  1. Click on "Deploy the stack".

:::tip For more information about using the application, please refer to How to use the application. :::