Skip to content

Administrator Guide

Complete guide for deploying, configuring, and maintaining File Organizer.

Quick Start

git clone https://github.com/curdriceaurora/Local-File-Organizer.git
cd Local-File-Organizer
docker-compose up -d

Access at http://localhost:8000

See Installation Guide for detailed setup.

Main Sections

Deployment

Operations

Key Topics

Installation

  • System requirements
  • Docker setup
  • Manual installation
  • AI model configuration

Deployment

  • Docker Compose setup
  • Reverse proxy configuration (nginx, Apache)
  • SSL/TLS setup
  • Environment variables

Configuration

  • Database setup (PostgreSQL)
  • Redis configuration
  • Ollama integration
  • File upload limits
  • Rate limiting

Monitoring

  • Health check endpoints
  • Logging configuration
  • Metrics collection
  • Performance monitoring

Security

  • User authentication
  • API key management
  • HTTPS/TLS configuration
  • Firewall rules

Backup & Recovery

  • Database backups
  • File backups
  • Restoration procedures
  • Disaster recovery

System Architecture

┌─────────────┐
│   Browser   │
└──────┬──────┘
       │ HTTP/WebSocket
┌──────▼──────────────────┐
│    FastAPI Web Server   │
│    (Python)             │
│    - REST API           │
│    - WebSocket          │
└──────┬──────────────────┘
       │
       ├─► PostgreSQL Database
       ├─► Redis Cache
       └─► Ollama (AI Models)

File System Storage

Installation Steps

  1. Install Docker (if using Docker)
  2. Clone Repository
  3. Configure Environment (copy .env.example to .env)
  4. Start Services (docker-compose up)
  5. Configure Settings (web interface)

See Installation Guide for details.

Configuration Checklist

  • System meets minimum requirements
  • Docker/Python installed
  • Ollama models pulled
  • PostgreSQL database running
  • Redis cache running
  • Environment variables set
  • File upload limits configured
  • Security settings configured
  • Backups scheduled

Monitoring Checklist

  • Health checks passing
  • Logs monitored
  • Disk space monitored
  • CPU/Memory usage normal
  • Database health checked
  • API response times acceptable
  • Backups verified

Maintenance Schedule

Daily

  • Check health endpoints
  • Review error logs
  • Monitor disk space

Weekly

  • Review user activity logs
  • Check backup integrity
  • Verify API performance

Monthly

  • Full system backup
  • Review security logs
  • Test restoration procedures
  • Update documentation

Quarterly

  • Update AI models if available
  • Security audit
  • Performance optimization
  • Capacity planning

Common Tasks

Start/Stop Services

# Start services
docker-compose up -d

# Stop services
docker-compose down

# View logs
docker-compose logs -f web

# Restart service
docker-compose restart web

Database Maintenance

# Backup database
docker-compose exec db pg_dump -U postgres file_organizer > backup.sql

# Restore database
docker-compose exec -T db psql -U postgres file_organizer < backup.sql

View Configuration

# Check current environment
docker-compose config

# View logs
docker-compose logs --tail=100 web

Troubleshooting

Common Issues

Services won't start

  • Check Docker running
  • Review error logs
  • Verify port availability

Out of memory

  • Check resource limits
  • Review running processes
  • Increase RAM allocation

Database connection failed

  • Verify PostgreSQL running
  • Check connection string
  • Review database logs

See Troubleshooting Guide for solutions.

Upgrade Procedure

  1. Backup database and files
  2. Pull latest code
  3. Review release notes
  4. Update Docker images
  5. Run migrations
  6. Test thoroughly
  7. Deploy to production

Support

Next Steps