Skip to content

Commit b5d49a3

Browse files
committed
📝(docs) Update OpenProject documentation
1 parent 6c610fe commit b5d49a3

File tree

2 files changed

+11
-85
lines changed

2 files changed

+11
-85
lines changed
Lines changed: 11 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,20 @@
1-
---
2-
sidebar_position: 10
3-
---
4-
51
# OpenProject
62

7-
Project management system for MijnBureau.
8-
9-
## Quick Start
10-
11-
```bash
12-
# Deploy OpenProject
13-
export MIJNBUREAU_MASTER_PASSWORD="demo-password"
14-
export MIJNBUREAU_CREATE_NAMESPACES=true
15-
helmfile -e demo -l name=openproject apply
16-
```
17-
18-
## Access
3+
MijnBureau supplies an installation of [OpenProject](https://www.openproject.org/). OpenProject is an open-source project management platform for planning, tracking, and collaborating on projects.
194

20-
- **URL**: `http://openproject.mb.test/`
21-
- **Login**: `admin@example.com` / `admin123`
5+
## Configuration
226

23-
## Features
7+
To configure OpenProject, override the default settings for your environment. The defaults are located in `helmfile/environments/default`.
248

25-
- Project planning with Gantt charts
26-
- Task management and time tracking
27-
- Team collaboration and file sharing
28-
- Project reporting and analytics
9+
## Authentication Integration
2910

30-
## Troubleshooting
11+
OpenProject integrates with MijnBureau authentication via:
3112

32-
```bash
33-
# Check status
34-
kubectl get pods -n mijn-bureau | grep openproject
13+
- **OIDC Authentication**: Single sign-on using Keycloak
14+
- **User Provisioning**: Automatic account creation from OIDC provider
15+
- **Group Mapping**: Synchronization of user groups and permissions
3516

36-
# Check logs
37-
kubectl logs -n mijn-bureau -l app.kubernetes.io/name=openproject
17+
## Notes
3818

39-
# Restart if needed
40-
kubectl rollout restart deployment/openproject-web -n mijn-bureau
41-
```
19+
> **Demo Environment:** Uses bundled PostgreSQL and memcached.
20+
> **Production Environment:** Use external database/cache and configure OIDC authentication.

helmfile/apps/openproject/README.md

Lines changed: 0 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -2,59 +2,6 @@
22

33
OpenProject is a web-based project management system for MijnBureau infrastructure.
44

5-
## Quick Start
6-
7-
### Demo Environment
8-
9-
```bash
10-
# Deploy OpenProject
11-
helmfile -e demo -l name=openproject apply
12-
13-
# Access: http://openproject.mb.test/
14-
# Login: admin@example.com / admin123
15-
```
16-
17-
### Production Environment
18-
19-
```bash
20-
# Deploy OpenProject
21-
helmfile -e production -l name=openproject apply
22-
23-
# Access: https://openproject.yourdomain.com/
24-
# Authentication: OIDC/SSO via Keycloak
25-
```
26-
27-
## Configuration
28-
29-
### Environment Variables
30-
31-
```bash
32-
export MIJNBUREAU_MASTER_PASSWORD="your-secure-password"
33-
export MIJNBUREAU_CREATE_NAMESPACES=true
34-
```
35-
36-
### Key Settings
37-
38-
| Environment | Database | TLS | SMTP | Resources |
39-
| ----------- | ------------------- | -------- | -------- | ----------- |
40-
| Demo | Bundled PostgreSQL | Disabled | Disabled | 4 CPU / 4Gi |
41-
| Production | External PostgreSQL | Enabled | Enabled | 8 CPU / 8Gi |
42-
43-
## Files
44-
45-
- `values.yaml.gotmpl` - Main OpenProject configuration
46-
- `helmfile-child.yaml.gotmpl` - Helmfile deployment configuration
47-
48-
## Troubleshooting
49-
50-
```bash
51-
# Check pod status
52-
kubectl get pods -n mijn-bureau | grep openproject
53-
54-
# Check logs
55-
kubectl logs -n mijn-bureau -l app.kubernetes.io/name=openproject
56-
```
57-
585
## Documentation
596

607
- [OpenProject Official Docs](https://www.openproject.org/docs/)

0 commit comments

Comments
 (0)