# Actual Server

**🟢 Productivity Service**

## 📋 Service Overview

| Property | Value |
|----------|-------|
| **Service Name** | Actual Budget |
| **Host** | Calypso |
| **Category** | Productivity / Finance |
| **Difficulty** | 🟢 |
| **Docker Image** | `actualbudget/actual-server:latest` |
| **Compose File** | `hosts/synology/calypso/actualbudget.yml` |
| **External URL** | `https://actual.vish.gg` |

## 🎯 Purpose

Actual Budget is a local-first personal finance and budgeting application. It supports envelope budgeting, transaction tracking, and syncing across devices.

## 🚀 Quick Start

### Prerequisites
- Docker and Docker Compose installed
- Basic understanding of REDACTED_APP_PASSWORD
- Access to the host system (Calypso)

### Deployment
```bash
# Navigate to service directory
cd Calypso

# Start the service
docker-compose up -d

# Check service status
docker-compose ps

# View logs
docker-compose logs -f actual_server
```

## 🔧 Configuration

### Docker Compose Configuration
```yaml
container_name: Actual
healthcheck:
  interval: 10s
  retries: 3
  start_period: 90s
  test: timeout 10s bash -c ':> /dev/tcp/127.0.0.1/5006' || exit 1
  timeout: 5s
image: actualbudget/actual-server:latest
ports:
- 8304:5006
restart: on-failure:5
security_opt:
- no-new-privileges:true
volumes:
- /volume1/docker/actual:/data:rw

```

### SSO / Authentik Integration

| Setting | Value |
|---------|-------|
| **Authentik App Slug** | `actual-budget` |
| **Authentik Provider PK** | `21` |
| **Discovery URL** | `https://sso.vish.gg/application/o/actual-budget/.well-known/openid-configuration` |
| **Redirect URI** | `https://actual.vish.gg/openid/callback` |
| **User Creation** | `ACTUAL_USER_CREATION_MODE=login` (auto-creates on first SSO login) |

### Environment Variables

### Port Mappings
| Host Port | Container Port | Protocol | Purpose |
|-----------|----------------|----------|----------|
| 8304 | 5006 | TCP | Service port |


### Volume Mappings
| Host Path | Container Path | Type | Purpose |
|-----------|----------------|------|----------|
| `/volume1/docker/actual` | `/data` | bind | Application data |


## 🌐 Access Information

Service ports: 8304:5006

## 🔒 Security Considerations

- ✅ Security options configured
- ⚠️ Consider running as non-root user

## 📊 Resource Requirements

No resource limits configured

### Recommended Resources
- **Minimum RAM**: 512MB
- **Recommended RAM**: 1GB+
- **CPU**: 1 core minimum
- **Storage**: Varies by usage

### Resource Monitoring
Monitor resource usage with:
```bash
docker stats
```

## 🔍 Health Monitoring

✅ Health check configured
**Test Command**: `timeout 10s bash -c ':> /dev/tcp/127.0.0.1/5006' || exit 1`
**Check Interval**: 10s
**Timeout**: 5s
**Retries**: 3

### Manual Health Checks
```bash
# Check container health
docker inspect --format='{{.State.Health.Status}}' CONTAINER_NAME

# View health check logs
docker inspect --format='{{range .State.Health.Log}}{{.Output}}{{end}}' CONTAINER_NAME
```

## 🚨 Troubleshooting

### Common Issues
**Service won't start**
- Check Docker logs: `docker-compose logs service-name`
- Verify port availability: `netstat -tulpn | grep PORT`
- Check file permissions on mounted volumes

**Can't access web interface**
- Verify service is running: `docker-compose ps`
- Check firewall settings
- Confirm correct port mapping

**Performance issues**
- Monitor resource usage: `docker stats`
- Check available disk space: `df -h`
- Review service logs for errors

### Useful Commands
```bash
# Check service status
docker-compose ps

# View real-time logs
docker-compose logs -f actual_server

# Restart service
docker-compose restart actual_server

# Update service
docker-compose pull actual_server
docker-compose up -d actual_server

# Access service shell
docker-compose exec actual_server /bin/bash
# or
docker-compose exec actual_server /bin/sh
```

## 📚 Additional Resources

- **Official Documentation**: Check the official docs for actual_server
- **Docker Hub**: [actualbudget/actual-server:latest](https://hub.docker.com/r/actualbudget/actual-server:latest)
- **Community Forums**: Search for community discussions and solutions
- **GitHub Issues**: Check the project's GitHub for known issues

## 🔗 Related Services

Services REDACTED_APP_PASSWORD actual_server:
- Nextcloud
- Paperless-NGX
- BookStack
- Syncthing

---

*This documentation is auto-generated from the Docker Compose configuration. For the most up-to-date information, refer to the official documentation and the actual compose file.*

**Last Updated**: 2026-03-16  
**Configuration Source**: `hosts/synology/calypso/actualbudget.yml`
