homelab-optimized/docs/services/individual/archivebox-scheduler.md

Archivebox Scheduler

🟢 Other Service

📋 Service Overview

Property	Value
Service Name	archivebox_scheduler
Host	homelab_vm
Category	Other
Difficulty	🟢
Docker Image	archivebox/archivebox:latest
Compose File	homelab_vm/archivebox.yaml
Directory	homelab_vm

🎯 Purpose

archivebox_scheduler 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 (homelab_vm)

Deployment

# Navigate to service directory
cd homelab_vm

# Start the service
docker-compose up -d

# Check service status
docker-compose ps

# View logs
docker-compose logs -f archivebox_scheduler

🔧 Configuration

Docker Compose Configuration

command: schedule --foreground --update --every=day
container_name: archivebox_scheduler
environment:
- PUID=1000
- PGID=1000
- TIMEOUT=120
- SEARCH_BACKEND_ENGINE=sonic
- SEARCH_BACKEND_HOST_NAME=sonic
- SEARCH_BACKEND_PASSWORD="REDACTED_PASSWORD"
image: archivebox/archivebox:latest
restart: unless-stopped
volumes:
- ./data:/data

Environment Variables

Variable	Value	Description
PUID	1000	User ID for file permissions
PGID	1000	Group ID for file permissions
TIMEOUT	120	Configuration variable
SEARCH_BACKEND_ENGINE	sonic	Configuration variable
SEARCH_BACKEND_HOST_NAME	sonic	Configuration variable
SEARCH_BACKEND_PASSWORD	***MASKED***	Configuration variable

Port Mappings

No ports exposed.

Volume Mappings

Host Path	Container Path	Type	Purpose
./data	/data	bind	Application data

🌐 Access Information

This service does not expose any web interfaces.

🔒 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 archivebox_scheduler

# Restart service
docker-compose restart archivebox_scheduler

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

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

📚 Additional Resources

• Official Documentation: Check the official docs for archivebox_scheduler
• Docker Hub: archivebox/archivebox: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 homelab_vm

---

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: homelab_vm/archivebox.yaml