Update README.md

This commit is contained in:
2025-06-08 16:43:13 +02:00
parent 3f945fa329
commit c3d4208e12

View File

@ -1,3 +1,4 @@
# 🛡️ HSP Guard # 🛡️ HSP Guard
**HSP Guard** is a modern OpenID Connect (OIDC) identity provider and access management system for home labs. It provides secure authentication and granular authorization for all your self-hosted services, combining ease of use with enterprise-level control — without any vendor lock-in. **HSP Guard** is a modern OpenID Connect (OIDC) identity provider and access management system for home labs. It provides secure authentication and granular authorization for all your self-hosted services, combining ease of use with enterprise-level control — without any vendor lock-in.
@ -78,3 +79,61 @@ Each user has a unique profile, roles, and group memberships.
"roles": ["GUEST"], "roles": ["GUEST"],
"permissions": ["dashboard.view", "music.play"] "permissions": ["dashboard.view", "music.play"]
} }
```
---
## 📡 **App Permission Discovery**
If your app supports permission discovery:
- Expose `/.well-known/guard-configuration` endpoint listing available permissions
- When registering in HSP Guard, auto-fetch and display for approval
#### **Example guard-configuration JSON**
```json
{
"permissions": [
"dashboard.view",
"dashboard.edit",
"dashboard.admin"
]
}
```
---
## 🔄 **User & Admin Sessions**
- List all active sessions (browser, app, device, timestamp)
- Revoke sessions (logout) from user or admin panel
---
## 📦 **Planned Features & Roadmap**
- [ ] **Group Management** for batch assignments
- [ ] **Audit Logging** of all admin/user actions
- [ ] **Permission Expiry** (time-limited access)
- [ ] **Advanced Web UI** (dark mode, mobile)
- [ ] **External Identity Providers** (login with Google, GitHub, etc.)
---
## 🛠️ **Development**
- See [CONTRIBUTING.md](CONTRIBUTING.md) for how to contribute!
- Pull requests and issues are welcome.
---
## 📝 **License**
MIT — open source, for the home lab community.
---
## 💬 **Feedback**
Open an [issue](https://github.com/yourusername/hsp-guard/issues) or join the discussion!
---