189 lines
4.2 KiB
Markdown
189 lines
4.2 KiB
Markdown
# Firefly
|
|
|
|
**🟡 Productivity Service**
|
|
|
|
## 📋 Service Overview
|
|
|
|
| Property | Value |
|
|
|----------|-------|
|
|
| **Service Name** | firefly |
|
|
| **Host** | Calypso |
|
|
| **Category** | Productivity |
|
|
| **Difficulty** | 🟡 |
|
|
| **Docker Image** | `fireflyiii/core:latest` |
|
|
| **Compose File** | `Calypso/firefly/firefly.yaml` |
|
|
| **Directory** | `Calypso/firefly` |
|
|
|
|
## 🎯 Purpose
|
|
|
|
firefly is a productivity application that helps manage tasks, documents, or workflows.
|
|
|
|
## 🚀 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/firefly
|
|
|
|
# Start the service
|
|
docker-compose up -d
|
|
|
|
# Check service status
|
|
docker-compose ps
|
|
|
|
# View logs
|
|
docker-compose logs -f firefly
|
|
```
|
|
|
|
## 🔧 Configuration
|
|
|
|
### Docker Compose Configuration
|
|
```yaml
|
|
container_name: Firefly
|
|
cpu_shares: 768
|
|
depends_on:
|
|
db:
|
|
condition: service_started
|
|
redis:
|
|
condition: service_healthy
|
|
env_file:
|
|
- stack.env
|
|
healthcheck:
|
|
test: curl -f http://localhost:8080/ || exit 1
|
|
hostname: firefly
|
|
image: fireflyiii/core:latest
|
|
mem_limit: 1g
|
|
ports:
|
|
- 6182:8080
|
|
restart: on-failure:5
|
|
security_opt:
|
|
- no-new-privileges:true
|
|
volumes:
|
|
- /volume1/docker/firefly/upload:/var/www/html/storage/upload:rw
|
|
|
|
```
|
|
|
|
### Environment Variables
|
|
No environment variables configured.
|
|
|
|
### Port Mappings
|
|
| Host Port | Container Port | Protocol | Purpose |
|
|
|-----------|----------------|----------|----------|
|
|
| 6182 | 8080 | TCP | Alternative HTTP port |
|
|
|
|
|
|
### Volume Mappings
|
|
| Host Path | Container Path | Type | Purpose |
|
|
|-----------|----------------|------|----------|
|
|
| `/volume1/docker/firefly/upload` | `/var/www/html/storage/upload` | bind | Data storage |
|
|
|
|
|
|
## 🌐 Access Information
|
|
|
|
### Web Interface
|
|
- **HTTP**: `http://Calypso:6182`
|
|
|
|
### Default Credentials
|
|
Refer to service documentation for default credentials
|
|
|
|
## 🔒 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**: `curl -f http://localhost:8080/ || exit 1`
|
|
|
|
### 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 firefly
|
|
|
|
# Restart service
|
|
docker-compose restart firefly
|
|
|
|
# Update service
|
|
docker-compose pull firefly
|
|
docker-compose up -d firefly
|
|
|
|
# Access service shell
|
|
docker-compose exec firefly /bin/bash
|
|
# or
|
|
docker-compose exec firefly /bin/sh
|
|
```
|
|
|
|
## 📚 Additional Resources
|
|
|
|
- **Official Documentation**: Check the official docs for firefly
|
|
- **Docker Hub**: [fireflyiii/core:latest](https://hub.docker.com/r/fireflyiii/core: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 firefly:
|
|
- 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**: 2025-11-17
|
|
**Configuration Source**: `Calypso/firefly/firefly.yaml`
|