Skip to content

Conversation

@gavinmcfall
Copy link

Summary

Add comprehensive documentation for running the PocketID provider plugin in containerized environments (Docker, Kubernetes).

Changes

  • Added standard installation steps
  • Added container/Kubernetes specific installation guide
  • Documented all environment variables with descriptions
  • Added Kubernetes Secret example
  • Added Docker Compose example
  • Documented user linking behavior (auto-link vs manual link)
  • Noted the composer dependency requirement for containerized deployments

Why

The existing README was minimal and didn't explain how to configure the plugin in containerized environments where setting environment variables is the primary configuration method. Users deploying Pelican on Kubernetes or Docker need to know:

  1. Which environment variables to set
  2. That the socialiteproviders/pocketid composer package is required
  3. How to configure the callback URL in PocketID
  4. How auto-create and auto-link user features work

Add comprehensive documentation for running PocketID provider in
containerized environments including:

- Required environment variables
- Composer dependency installation notes
- Kubernetes Secret example
- Docker Compose example
- User linking behavior documentation
@gavinmcfall
Copy link
Author

Note: The CI failure is a pre-existing issue with the repo's composer.lock being out of sync with dependencies (firebase/php-jwt version mismatch). This PR only modifies the README.md file and does not affect any code or dependencies.

@Boy132
Copy link
Member

Boy132 commented Jan 16, 2026

Thanks, but the install issues when using dockerized panel will be resolved eventually.
There should be no differences for plugin installations due to the panel installation method.

@Boy132 Boy132 closed this Jan 16, 2026
@gavinmcfall
Copy link
Author

Is there a timeline for that? people may very well appreciate the workaround.
Happy to adjust the PR to show this is a temporary workaround

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.

2 participants