4.4 KiB
4.4 KiB
Cocalc
🟢 Other Service
📋 Service Overview
| Property | Value |
|---|---|
| Service Name | cocalc |
| Host | guava |
| Category | Other |
| Difficulty | 🟢 |
| Docker Image | sagemathinc/cocalc-docker:latest |
| Compose File | guava/portainer_yaml/cocalc.yaml |
| Directory | guava/portainer_yaml |
🎯 Purpose
cocalc is a specialized service that provides specific functionality for the homelab infrastructure.
🚀 Quick Start
Prerequisites
- Docker and Docker Compose installed
- Basic understanding of REDACTED_APP_PASSWORD
- Access to the host system (guava)
Deployment
# Navigate to service directory
cd guava/portainer_yaml
# Start the service
docker-compose up -d
# Check service status
docker-compose ps
# View logs
docker-compose logs -f cocalc
🔧 Configuration
Docker Compose Configuration
container_name: cocalc
environment:
- TZ=America/Los_Angeles
- COCALC_NATS_AUTH=false
image: sagemathinc/cocalc-docker:latest
ports:
- 8080:443
restart: unless-stopped
volumes:
- /mnt/data/cocalc/projects:/projects
- /mnt/data/cocalc/home:/home/cocalc
- /mnt/data/cocalc/library:/projects/library
Environment Variables
| Variable | Value | Description |
|---|---|---|
TZ |
America/Los_Angeles |
Timezone setting |
COCALC_NATS_AUTH |
false |
Configuration variable |
Port Mappings
| Host Port | Container Port | Protocol | Purpose |
|---|---|---|---|
| 8080 | 443 | TCP | HTTPS web interface |
Volume Mappings
| Host Path | Container Path | Type | Purpose |
|---|---|---|---|
/mnt/data/cocalc/projects |
/projects |
bind | Data storage |
/mnt/data/cocalc/home |
/home/cocalc |
bind | Data storage |
/mnt/data/cocalc/library |
/projects/library |
bind | Data storage |
🌐 Access Information
Web Interface
- HTTP:
http://guava:8080
Default Credentials
Refer to service documentation for default credentials
🔒 Security Considerations
- ⚠️ Consider adding security options (no-new-privileges)
- ⚠️ 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:
docker stats
🔍 Health Monitoring
⚠️ No health check configured Consider adding a health check:
healthcheck:
test: ["CMD", "curl", "-f", "http://localhost:PORT/health"]
interval: 30s
timeout: 10s
retries: 3
Manual Health Checks
# 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
# Check service status
docker-compose ps
# View real-time logs
docker-compose logs -f cocalc
# Restart service
docker-compose restart cocalc
# Update service
docker-compose pull cocalc
docker-compose up -d cocalc
# Access service shell
docker-compose exec cocalc /bin/bash
# or
docker-compose exec cocalc /bin/sh
📚 Additional Resources
- Official Documentation: Check the official docs for cocalc
- Docker Hub: sagemathinc/cocalc-docker:latest
- Community Forums: Search for community discussions and solutions
- GitHub Issues: Check the project's GitHub for known issues
🔗 Related Services
Other services in the other category on guava
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: 2025-11-17
Configuration Source: guava/portainer_yaml/cocalc.yaml