[PR #82] [CLOSED] docs(pocketid-provider): add container/Kubernetes installation guide #102

Closed
opened 2026-05-07 00:18:07 +02:00 by BreizhHardware · 0 comments

📋 Pull Request Information

Original PR: https://github.com/pelican-dev/plugins/pull/82
Author: @gavinmcfall
Created: 1/16/2026
Status: Closed

Base: mainHead: docs/pocketid-container-usage


📝 Commits (1)

  • d2bc4f6 docs(pocketid-provider): add container/Kubernetes installation guide

📊 Changes

1 file changed (+76 additions, -4 deletions)

View changed files

📝 pocketid-provider/README.md (+76 -4)

📄 Description

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

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/pelican-dev/plugins/pull/82 **Author:** [@gavinmcfall](https://github.com/gavinmcfall) **Created:** 1/16/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `docs/pocketid-container-usage` --- ### 📝 Commits (1) - [`d2bc4f6`](https://github.com/pelican-dev/plugins/commit/d2bc4f66318377414b2fe37630e3036aa8abe02f) docs(pocketid-provider): add container/Kubernetes installation guide ### 📊 Changes **1 file changed** (+76 additions, -4 deletions) <details> <summary>View changed files</summary> 📝 `pocketid-provider/README.md` (+76 -4) </details> ### 📄 Description ## 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 --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
BreizhHardware 2026-05-07 00:18:07 +02:00
Sign in to join this conversation.
No labels
pull-request
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/plugins#102
No description provided.