205 lines
5.0 KiB
Markdown
205 lines
5.0 KiB
Markdown
# Archivebox
|
|
|
|
**🟢 Other Service**
|
|
|
|
## 📋 Service Overview
|
|
|
|
| Property | Value |
|
|
|----------|-------|
|
|
| **Service Name** | archivebox |
|
|
| **Host** | homelab_vm |
|
|
| **Category** | Other |
|
|
| **Difficulty** | 🟢 |
|
|
| **Docker Image** | `archivebox/archivebox:latest` |
|
|
| **Compose File** | `homelab_vm/archivebox.yaml` |
|
|
| **Directory** | `homelab_vm` |
|
|
|
|
## 🎯 Purpose
|
|
|
|
archivebox 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
|
|
```bash
|
|
# 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
|
|
```
|
|
|
|
## 🔧 Configuration
|
|
|
|
### Docker Compose Configuration
|
|
```yaml
|
|
container_name: archivebox
|
|
environment:
|
|
- PUID=1000
|
|
- PGID=1000
|
|
- ADMIN_USERNAME=vish
|
|
- ADMIN_PASSWORD="REDACTED_PASSWORD"
|
|
- ALLOWED_HOSTS=*
|
|
- CSRF_TRUSTED_ORIGINS=http://localhost:7254
|
|
- PUBLIC_INDEX=True
|
|
- PUBLIC_SNAPSHOTS=True
|
|
- PUBLIC_ADD_VIEW=False
|
|
- SEARCH_BACKEND_ENGINE=sonic
|
|
- SEARCH_BACKEND_HOST_NAME=sonic
|
|
- SEARCH_BACKEND_PASSWORD="REDACTED_PASSWORD"
|
|
image: archivebox/archivebox:latest
|
|
ports:
|
|
- 7254:8000
|
|
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 |
|
|
| `ADMIN_USERNAME` | `vish` | Configuration variable |
|
|
| `ADMIN_PASSWORD` | `***MASKED***` | Administrator password |
|
|
| `ALLOWED_HOSTS` | `*` | Configuration variable |
|
|
| `CSRF_TRUSTED_ORIGINS` | `http://localhost:7254` | Configuration variable |
|
|
| `PUBLIC_INDEX` | `True` | Configuration variable |
|
|
| `PUBLIC_SNAPSHOTS` | `True` | Configuration variable |
|
|
| `PUBLIC_ADD_VIEW` | `False` | Configuration variable |
|
|
| `SEARCH_BACKEND_ENGINE` | `sonic` | Configuration variable |
|
|
| `SEARCH_BACKEND_HOST_NAME` | `sonic` | Configuration variable |
|
|
| `SEARCH_BACKEND_PASSWORD` | `***MASKED***` | Configuration variable |
|
|
|
|
|
|
### Port Mappings
|
|
| Host Port | Container Port | Protocol | Purpose |
|
|
|-----------|----------------|----------|----------|
|
|
| 7254 | 8000 | TCP | Service port |
|
|
|
|
|
|
### Volume Mappings
|
|
| Host Path | Container Path | Type | Purpose |
|
|
|-----------|----------------|------|----------|
|
|
| `./data` | `/data` | bind | Application data |
|
|
|
|
|
|
## 🌐 Access Information
|
|
|
|
### Web Interface
|
|
- **HTTP**: `http://homelab_vm:7254`
|
|
|
|
### 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:
|
|
```bash
|
|
docker stats
|
|
```
|
|
|
|
## 🔍 Health Monitoring
|
|
|
|
⚠️ No health check configured
|
|
Consider adding a health check:
|
|
```yaml
|
|
healthcheck:
|
|
test: ["CMD", "curl", "-f", "http://localhost:PORT/health"]
|
|
interval: 30s
|
|
timeout: 10s
|
|
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 archivebox
|
|
|
|
# Restart service
|
|
docker-compose restart archivebox
|
|
|
|
# Update service
|
|
docker-compose pull archivebox
|
|
docker-compose up -d archivebox
|
|
|
|
# Access service shell
|
|
docker-compose exec archivebox /bin/bash
|
|
# or
|
|
docker-compose exec archivebox /bin/sh
|
|
```
|
|
|
|
## 📚 Additional Resources
|
|
|
|
- **Official Documentation**: Check the official docs for archivebox
|
|
- **Docker Hub**: [archivebox/archivebox:latest](https://hub.docker.com/r/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`
|