docs: enhance OIDC provider setup and roadmap documentation

elibosley · elibosley · commit 0afc4e8e9a5d · 2025-08-15T13:14:34.000-04:00
- Updated OIDC provider setup instructions to clarify redirect URI protocol requirements.
- Revised security best practices to emphasize the importance of using HTTPS.
- Expanded the upcoming features section with a detailed roadmap, including completed and planned features for the Unraid API.
diff --git a/api/docs/public/oidc-provider-setup.md b/api/docs/public/oidc-provider-setup.md
@@ -247,7 +247,7 @@ The **Issuer URL** field accepts both formats, but **base URL is strongly recomm
 
 - Ensure the redirect URI in your provider matches exactly
 - Include the correct port if using a non-standard configuration
-- Use HTTP for local, HTTPS for production
+- Verify the redirect URI protocol matches your server's configuration (HTTP or HTTPS)
 
 #### Cannot see login button
 
@@ -272,7 +272,7 @@ LOG_LEVEL=debug unraid-api start --debug
 
 ## Security Best Practices
 
-1. **Always use HTTPS in production** - OAuth requires secure connections
+1. **Use HTTPS when possible** - Provides encrypted connections for authentication
 2. **Use Simple Mode for authorization** - Prevents overly accepting configurations and reduces misconfiguration risks
 3. **Be specific with authorization** - Don't use overly broad rules
 4. **Rotate secrets regularly** - Update client secrets periodically
@@ -296,8 +296,8 @@ The Unraid.net provider is built-in and pre-configured. You only need to configu
 - **Client ID/Secret**: Pre-configured (built-in provider)
 - **Redirect URI**: `http://YOUR_UNRAID_IP/graphql/api/auth/oidc/callback`
 
-:::warning[Security Notice]
-**Always use HTTPS for production redirect URIs!** The examples above use HTTP for initial setup and testing only. In production environments, you MUST use HTTPS (e.g., `https://YOUR_UNRAID_IP/graphql/api/auth/oidc/callback`) to ensure secure communication and prevent credential interception. Most OIDC providers will reject HTTP redirect URIs for security reasons.
+:::tip[Redirect URI Protocol]
+**Match the protocol to your server setup:** Use `http://` if accessing your Unraid server without SSL/TLS (typical for local network access). Use `https://` if you've configured SSL/TLS on your server. Some OIDC providers (like Google) require HTTPS and won't accept HTTP redirect URIs.
 :::
 
 Configure authorization rules using Simple Mode (allowed email domains/addresses) or Advanced Mode for complex requirements.
diff --git a/api/docs/public/upcoming-features.md b/api/docs/public/upcoming-features.md
@@ -1,71 +1,172 @@
-# Upcoming Features
+---
+title: Roadmap & Features
+description: Current status and upcoming features for the Unraid API
+sidebar_position: 10
+---
 
-Note: This roadmap outlines planned features and improvements for the Unraid API. Features and timelines may change based on development priorities and community feedback.
+# Roadmap & Features
+
+:::info Development Status
+This roadmap outlines completed and planned features for the Unraid API. Features and timelines may change based on development priorities and community feedback.
+:::
+
+## Feature Status Legend
+
+| Status | Description |
+|--------|-------------|
+| ✅ **Done** | Feature is complete and available |
+| 🚧 **In Progress** | Currently under active development |
+| 📅 **Planned** | Scheduled for future development |
+| 💡 **Under Consideration** | Being evaluated for future inclusion |
 
 ## Core Infrastructure
 
-| Feature | Status | Tag |
-|---------|--------|-----|
-| API Development Environment Improvements | Done | v4.0.0 |
-| Include API in Unraid OS | Planned (Q1 2025) | - |
-| Make API Open Source | Planned (Q1 2025) | - |
-| Separate API from Connect Plugin | Planned (Q2 2025) | - |
-| Developer Tools for Plugins | Planned (Q2 2025) | - |
+### Completed Features ✅
+
+| Feature | Available Since |
+|---------|-----------------|
+| **API Development Environment Improvements** | v4.0.0 |
+| **Include API in Unraid OS** | Unraid v7.2-beta.1 |
+| **Separate API from Connect Plugin** | Unraid v7.2-beta.1 |
+
+### Upcoming Features 📅
+
+| Feature | Target Timeline |
+|---------|-----------------|
+| **Make API Open Source** | Q1 2025 |
+| **Developer Tools for Plugins** | Q2 2025 |
 
 ## Security & Authentication
 
-| Feature | Status | Tag |
-|---------|--------|-----|
-| Permissions System Rewrite | Done | v4.0.0 |
-| User Interface Component Library | In Progress | - |
+### Completed Features ✅
+
+| Feature | Available Since |
+|---------|-----------------|
+| **Permissions System Rewrite** | v4.0.0 |
+| **OIDC/SSO Support** | Unraid v7.2-beta.1 |
+
+### In Development 🚧
+
+- **User Interface Component Library** - Enhanced security components for the UI
 
 ## User Interface Improvements
 
-| Feature | Status | Tag |
-|---------|--------|-----|
-| New Settings Pages | Planned (Q2 2025) | - |
-| Custom Theme Creator | Planned (Q2-Q3 2025) | - |
-| New Connect Settings Interface | Planned (Q1 2025) | - |
+### Planned Features 📅
+
+| Feature | Target Timeline | Description |
+|---------|-----------------|-------------|
+| **New Settings Pages** | Q2 2025 | Modernized settings interface with improved UX |
+| **Custom Theme Creator** | Q2-Q3 2025 | Allow users to create and share custom themes |
+| **New Connect Settings Interface** | Q1 2025 | Redesigned Unraid Connect configuration |
 
 ## Array Management
 
-| Feature | Status | Tag |
-|---------|--------|-----|
-| Array Status Monitoring | Done | v4.0.0 |
-| Storage Pool Creation Interface | Planned (Q2 2025) | - |
-| Storage Pool Status Interface | Planned (Q2 2025) | - |
+### Completed Features ✅
+
+| Feature | Available Since |
+|---------|-----------------|
+| **Array Status Monitoring** | v4.0.0 |
+
+### Planned Features 📅
+
+| Feature | Target Timeline | Description |
+|---------|-----------------|-------------|
+| **Storage Pool Creation Interface** | Q2 2025 | Simplified pool creation workflow |
+| **Storage Pool Status Interface** | Q2 2025 | Real-time pool health monitoring |
 
 ## Docker Integration
 
-| Feature | Status | Tag |
-|---------|--------|-----|
-| Docker Container Status Monitoring | Done | v4.0.0 |
-| New Docker Status Interface Design | Planned (Q3 2025) | - |
-| New Docker Status Interface | Planned (Q3 2025) | - |
-| Docker Container Setup Interface | Planned (Q3 2025) | - |
-| Docker Compose Support | Planned | - |
+### Completed Features ✅
+
+| Feature | Available Since |
+|---------|-----------------|
+| **Docker Container Status Monitoring** | v4.0.0 |
+
+### Planned Features 📅
+
+| Feature | Target Timeline | Description |
+|---------|-----------------|-------------|
+| **New Docker Status Interface Design** | Q3 2025 | Modern container management UI |
+| **New Docker Status Interface** | Q3 2025 | Implementation of new design |
+| **Docker Container Setup Interface** | Q3 2025 | Streamlined container deployment |
+| **Docker Compose Support** | TBD | Native docker-compose.yml support |
 
 ## Share Management
 
-| Feature | Status | Tag |
-|---------|--------|-----|
-| Array/Cache Share Status Monitoring | Done | v4.0.0 |
-| Storage Share Creation & Settings | Planned | - |
-| Storage Share Management Interface | Planned | - |
+### Completed Features ✅
+
+| Feature | Available Since |
+|---------|-----------------|
+| **Array/Cache Share Status Monitoring** | v4.0.0 |
+
+### Under Consideration 💡
+
+- **Storage Share Creation & Settings** - Enhanced share configuration options
+- **Storage Share Management Interface** - Unified share management dashboard
 
 ## Plugin System
 
-| Feature | Status | Tag |
-|---------|--------|-----|
-| New Plugins Interface | Planned (Q3 2025) | - |
-| Plugin Management Interface | Planned | - |
-| Plugin Development Tools | Planned | - |
+### Planned Features 📅
+
+| Feature | Target Timeline | Description |
+|---------|-----------------|-------------|
+| **New Plugins Interface** | Q3 2025 | Redesigned plugin management UI |
+| **Plugin Management Interface** | TBD | Advanced plugin configuration |
+| **Plugin Development Tools** | TBD | SDK and tooling for developers |
 
 ## Notifications
 
-| Feature | Status | Tag |
-|---------|--------|-----|
-| Notifications System | Done | v4.0.0 |
-| Notifications Interface | Done | v4.0.0 |
+### Completed Features ✅
+
+| Feature | Available Since |
+|---------|-----------------|
+| **Notifications System** | v4.0.0 |
+| **Notifications Interface** | v4.0.0 |
+
+---
+
+## Recent Releases
+
+:::info Full Release History
+For a complete list of all releases, changelogs, and download links, visit the [Unraid API GitHub Releases](https://github.com/unraid/api/releases) page.
+:::
+
+### Unraid v7.2-beta.1 Highlights
+
+- 🎉 **API included in Unraid OS** - Native integration
+- 🔐 **OIDC/SSO Support** - Enterprise authentication
+- 📦 **Standalone API** - Separated from Connect plugin
+
+### v4.0.0 Highlights
+
+- 🛡️ **Permissions System Rewrite** - Enhanced security
+- 📊 **Comprehensive Monitoring** - Array, Docker, and Share status
+- 🔔 **Notifications System** - Real-time alerts and notifications
+- 🛠️ **Developer Environment** - Improved development tools
+
+## Community Feedback
+
+:::tip Have a Feature Request?
+We value community input! Please submit feature requests and feedback through:
+
+- [Unraid Forums](https://forums.unraid.net)
+- [GitHub Issues](https://github.com/unraid/api/issues) - API is open source!
+
+:::
+
+## Version Support
+
+| Unraid Version | API Version | Support Status |
+|----------------|-------------|----------------|
+| Unraid v7.2-beta.1+ | Latest | ✅ Active |
+| 7.0 - 7.1.x | v4.x via Plugin | ⚠️ Limited |
+| 6.12.x | v4.x via Plugin | ⚠️ Limited |
+| < 6.12 | Not Supported | ❌ EOL |
+
+:::warning Legacy Support
+Versions prior to Unraid 7.2 require the API to be installed through the Unraid Connect plugin. Some features may not be available on older versions.
+:::
 
-Features marked as "Done" are available in current releases. The tag column shows the version where a feature was first introduced.
+:::tip Development Builds
+You can always install the Unraid Connect plugin to track the latest released development changes and get early access to new API features before they're included in Unraid OS releases.
+:::
