bthe0/captainarr

A comprehensive Docker-based media server stack with automated management, monitoring, and organization.

           |    |    |
          )_)  )_)  )_)
         )___))___))___)
      )____)____)_____)
   _____|____|____|____\\___    
~~~\___________________________/~~~  
    ~~~    ~    ~~~    ~   ~~~     CaptainArr
    

CaptainArr Media Server Stack

A comprehensive Docker-based media server stack with automated management, monitoring, and organization.

Disclaimer: This project is for educational purposes only. It is intended to showcase open-source software concepts and demonstrate server components. Use responsibly and with awareness of any applicable licensing and usage policies.

Installation • Configuration • Services • Post-Install Setup • Maintenance • Security • Troubleshooting

📋 Quick Start

1. Clone the repository

git clone https://github.com/bthe0/captainarr.git
cd captainarr

Option 1: Standard Installation

2. Set up environment

cp .env.example .env
nano .env

3. Install and start

./install.sh

Option 2: Quick Installation with Defaults

2. Install with defaults

./install.sh --defaults

3. Set Plex claim token

# Get your token from https://www.plex.tv/claim
nano .env

4. Start services

./captainarr.sh start

Default Credentials:

• Arr Services (Radarr/Sonarr/etc): admin/admin
• Homarr: admin/Admin123!
• Calibre: admin/admin123
• qBittorrent: admin/adminadmin

Important: Change these default passwords as soon as possible after installation!

Once the installation and startup are complete, check Services for more information about accessing and configuring each service.

📚 Documentation

• Installation Guide

  • Prerequisites
  • Installation steps
  • Initial configuration
  • Default installation option

• Configuration Guide

  • Environment variables
  • Directory structure
  • Path mappings

• Services Overview

  • Available services
  • Default ports
  • Service descriptions

• Post-Installation Setup

  • Step-by-step service configuration
  • Integration setup
  • Media organization

• Security Guide

  • Default credentials
  • Authentication setup
  • Security best practices

• Maintenance Guide

  • Backup and restore
  • Updates
  • Health monitoring

• Troubleshooting Guide

  • Common issues
  • Logs and diagnostics
  • Solutions

🛠 Basic Usage

./captainarr.sh <command> [options]

Commands:
  start     - Start all services
  stop      - Stop all services
  restart   - Restart all services
  status    - Show service status
  logs      - View service logs
  update    - Update containers
  backup    - Create backup
  check     - Run health check
  help      - Show help

👥 Contributing

Contributions are welcome!

📝 License

This project is licensed under the MIT License.

---

Made with ❤️ by bthe0