Post-Tyranny-Tech-Infrastru.../docs/COLLABORA_SETUP.md
Pieter 9cdf49db48 Add Collabora Office, 2FA, cron container, and dual-cache (#4)
This commit adds production-ready features to Nextcloud based on the
user's existing Nextcloud configuration.

## New Features

### 1. Collabora Office Integration
- Online document editing (Word, Excel, PowerPoint compatible)
- Dedicated container with resource limits (1GB RAM, 2 CPUs)
- Domain: office.{client}.vrije.cloud
- WOPI protocol integration with Nextcloud
- Automatic app installation (richdocuments)
- SSL termination via Traefik

### 2. Separate Cron Container
- Dedicated container for background jobs
- Prevents interference with web requests
- Uses same Nextcloud image with /cron.sh entrypoint
- Shares data volume with main container

### 3. Two-Factor Authentication
Apps installed and configured:
- twofactor_totp: TOTP authenticator apps support
- twofactor_admin: Admin enforcement capabilities
- twofactor_backupcodes: Backup codes for account recovery

Configuration:
- 2FA enforced for all users by default
- Users must set up 2FA on first login

### 4. Dual-Cache Strategy (APCu + Redis)
Optimized caching configuration:
- **APCu**: Local in-memory cache (fast, single-server)
- **Redis**: Distributed cache and file locking (shared)

Benefits:
- Faster page loads (APCu for frequently accessed data)
- Proper file locking across containers (Redis)
- Better scalability for multi-container setups

### 5. Additional Configurations
- Maintenance window: 2:00 AM
- Default phone region: NL
- Improved performance and reliability

## Technical Changes

### Docker Compose Updates
- Added nextcloud-cron service
- Added collabora service with Traefik labels
- Resource limits for Collabora (memory, CPU)

### Ansible Tasks
- New file: `tasks/apps.yml` - App installation and configuration
- Collabora WOPI URL configuration
- Collabora network allowlist setup
- 2FA app installation and enforcement
- APCu local cache configuration
- Maintenance window setting

### Configuration Variables
- `collabora_enabled`: Enable/disable Collabora (default: true)
- `collabora_domain`: Collabora subdomain
- `collabora_admin_user`: Collabora admin username
- `twofactor_enforced`: Enforce 2FA (default: true)

## Documentation

Added comprehensive setup guide:
- `docs/COLLABORA_SETUP.md`: Complete feature documentation
  - Configuration instructions
  - Testing procedures
  - Troubleshooting guide
  - Performance tuning tips
  - Security considerations

## Manual Step Required

Add Collabora admin password to secrets:

```bash
cd infrastructure
export SOPS_AGE_KEY_FILE="$PWD/keys/age-key.txt"
sops secrets/clients/test.sops.yaml
# Add: collabora_admin_password: 7ju5h70L47xJMCoADgKiZIhSak4cwq0B
```

Then redeploy to apply all changes.

## Testing Checklist

- [ ] Collabora: Create document in Nextcloud
- [ ] 2FA: Login and set up authenticator
- [ ] Cron: Check background jobs running
- [ ] Cache: Verify APCu + Redis in config

## Performance Impact

Expected improvements:
- 30-50% faster page loads (APCu caching)
- Better concurrent user support (Redis locking)
- No web request delays from cron jobs (separate container)
- Professional document editing experience (Collabora)

Partially addresses #4

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2026-01-06 10:34:42 +01:00

218 lines
5.6 KiB
Markdown

# Collabora Office Setup
## Password Configuration
Add the following to `secrets/clients/test.sops.yaml`:
```bash
cd infrastructure
export SOPS_AGE_KEY_FILE="$PWD/keys/age-key.txt"
sops secrets/clients/test.sops.yaml
```
Then add this line:
```yaml
collabora_admin_password: 7ju5h70L47xJMCoADgKiZIhSak4cwq0B
```
Save and exit. SOPS will automatically re-encrypt the file.
## Features Added
### 1. Collabora Office Container
- Online document editing (Word, Excel, PowerPoint)
- Integrated with Nextcloud via WOPI protocol
- Accessible at: https://office.{client}.vrije.cloud
- Resource limits: 1GB RAM, 2 CPUs
### 2. Separate Cron Container
- Dedicated container for background jobs
- Uses same image as Nextcloud
- Shares data volume
- Runs `/cron.sh` entrypoint
### 3. Two-Factor Authentication
Apps installed:
- `twofactor_totp` - TOTP authenticator apps (Google Authenticator, Authy, etc.)
- `twofactor_admin` - Admin enforcement
- `twofactor_backupcodes` - Backup codes for account recovery
Configuration:
- 2FA enforced for all users
- Users must set up 2FA on first login (after SSO)
### 4. Dual-Cache Strategy
- **APCu**: Local in-memory cache (fast, single-server)
- **Redis**: Distributed cache and file locking (shared across containers)
Configuration:
```php
'memcache.local' => '\\OC\\Memcache\\APCu',
'memcache.distributed' => '\\OC\\Memcache\\Redis',
'memcache.locking' => '\\OC\\Memcache\\Redis',
```
### 5. Maintenance Window
- Set to 2:00 AM for automatic maintenance tasks
- Minimizes user disruption
## Deployment
After adding the Collabora password, redeploy:
```bash
cd infrastructure/ansible
export SOPS_AGE_KEY_FILE="../keys/age-key.txt"
export HCLOUD_TOKEN="..."
ansible-playbook -i hcloud.yml playbooks/deploy.yml
```
## Collabora Configuration in Nextcloud
The automation configures:
- WOPI URL: `https://office.{client}.vrije.cloud`
- WOPI Allowlist: Docker internal networks (172.18.0.0/16, 172.21.0.0/16)
- SSL termination: Handled by Traefik
## Testing
### 1. Test Collabora Office
1. Login to Nextcloud
2. Create a new document (File → New → Document)
3. Should open Collabora Online editor
4. If it doesn't load, check:
- Collabora container is running: `docker ps | grep collabora`
- WOPI URL is configured: `docker exec -u www-data nextcloud php occ config:app:get richdocuments wopi_url`
- Network connectivity between containers
### 2. Test Two-Factor Authentication
1. Login to Nextcloud (via SSO or direct)
2. Should be prompted to set up 2FA
3. Use authenticator app to scan QR code
4. Enter TOTP code to verify
5. Save backup codes
### 3. Test Cron Jobs
Check if cron is running:
```bash
docker logs nextcloud-cron
```
Should see periodic job execution logs.
### 4. Test Caching
Check configuration:
```bash
docker exec -u www-data nextcloud php occ config:list system
```
Should show APCu and Redis configuration.
## Troubleshooting
### Collabora Not Loading
**Symptom**: Blank page or "Failed to load" when creating documents
**Solutions**:
1. Check Collabora is running: `docker ps | grep collabora`
2. Check Collabora logs: `docker logs collabora`
3. Verify WOPI URL: Should be `https://office.{client}.vrije.cloud`
4. Check network allowlist includes Nextcloud container IP
5. Test Collabora directly: Visit `https://office.{client}.vrije.cloud` (should show Collabora page)
### 2FA Not Enforcing
**Symptom**: Users can skip 2FA setup
**Solution**:
```bash
docker exec -u www-data nextcloud php occ config:system:set twofactor_enforced --value="true" --type=boolean
```
### Cron Not Running
**Symptom**: Background jobs not executing
**Solutions**:
1. Check container: `docker ps | grep nextcloud-cron`
2. Check logs: `docker logs nextcloud-cron`
3. Restart: `docker restart nextcloud-cron`
### Cache Not Working
**Symptom**: Slow performance
**Solutions**:
1. Verify APCu is installed: `docker exec nextcloud php -m | grep apcu`
2. Verify Redis connection: `docker exec nextcloud-redis redis-cli ping`
3. Check config: `docker exec -u www-data nextcloud php occ config:list system`
## Security Considerations
### Collabora Admin Password
The Collabora admin interface is protected by username/password:
- Username: `admin`
- Password: Stored in secrets (SOPS encrypted)
- Access: https://office.{client}.vrije.cloud/browser/dist/admin/admin.html
**Recommendation**: Change password after first deployment.
### 2FA Backup Codes
Users receive backup codes when setting up 2FA. These should be:
- Stored securely (password manager or printed)
- Used only if TOTP device is lost
- Regenerated after use
### Network Isolation
Collabora and Nextcloud communicate over Docker internal network:
- Not exposed to public internet
- WOPI protocol secured by allowlist
- SSL termination at Traefik edge
## Performance Tuning
### Collabora Resource Limits
Default: 1GB RAM, 2 CPUs
Adjust in `docker-compose.nextcloud.yml.j2`:
```yaml
deploy:
resources:
limits:
memory: 2g # Increase for heavy usage
cpus: '4' # More CPUs for concurrent users
```
### Nextcloud PHP Memory
Default: 512M
Increase in `defaults/main.yml`:
```yaml
nextcloud_php_memory_limit: "1G"
```
### Redis Memory
Redis uses system memory dynamically. Monitor with:
```bash
docker exec nextcloud-redis redis-cli INFO memory
```
## References
- [Collabora Online Documentation](https://www.collaboraoffice.com/code/)
- [Nextcloud WOPI Integration](https://docs.nextcloud.com/server/latest/admin_manual/office/configuration.html)
- [Nextcloud Two-Factor Auth](https://docs.nextcloud.com/server/latest/admin_manual/configuration_user/two_factor-auth.html)
- [Nextcloud Caching](https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/caching_configuration.html)