Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document OAuth config env variables for docker #3213

Closed
wants to merge 1 commit into from

Conversation

osresearch
Copy link

This patch adds documentation to Administration - OAuth for setting the docker-compose environment to include the OIDC provider information and also adds a sample configuration to the example.env file.

This patch adds documentation to Administration - OAuth
for setting the docker-compose environment to include the
OIDC provider information and also adds a sample configuration
to the example.env file.

Signed-off-by: Trammell Hudson <hudson@trmm.net>
@vercel
Copy link

vercel bot commented Jul 11, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
immich ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 11, 2023 1:45pm

@bo0tzz
Copy link
Member

bo0tzz commented Jul 11, 2023

I don't think the env vars for oauth config are supported anymore?

@osresearch
Copy link
Author

Why were they removed? .env vars are necessary for automated deployments and requiring a manual step via the website to set it up is problematic compared to being able to include them in the runtime configuration.

@jrasm91
Copy link
Contributor

jrasm91 commented Jul 11, 2023

Why were they removed? .env vars are necessary for automated deployments and requiring a manual step via the website to set it up is problematic compared to being able to include them in the runtime configuration.

I don't disagree, but the trade-off to keep them was increased maintenance work. It is very uncommon to need to regularly run automated deployments of immich and preconfigure OAuth, so we went with a simpler approach of only configuring these values through the UI.

@osresearch
Copy link
Author

I'm hoping to integrate immich into the https://v.st/ self-hosted system, which uses single-sign-on for all of the included tools (mastodon, matrix, hedgedoc, nextcloud, etc). Being able to help folks setup a community with all of the tools pre-configured to work together using a single docker-compose command is much easier for groups that don't want to have to separately go through each tool to figure out how its SSO or OIDC vars are configured.

@jrasm91
Copy link
Contributor

jrasm91 commented Jul 14, 2023

In the short term, I don't think we are going to add support for auto configuring OAuth or any other settings via environment variables. While not ideal, I'm sure you can accomplish the same thing via a script. Either using the CLI to updates the values, inserting them directly into the database, or injecting a migration file into the container via a volume mount or extending the image.

@bo0tzz bo0tzz closed this Jul 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants