amazingmoaaz/askarr repository overview

⁠Askarr

⁠Advanced Media Request Management via Chat Integration

Enterprise-grade solution for Sonarr, Radarr, Lidarr, Overseerr and Ombi

⁠🐳 Docker Quick Start

⁠Pull the Latest Image

docker pull amazingmoaaz/askarr:latest

⁠Run Askarr

docker run -d \
  --name askarr \
  -p 4545:4545 \
  -v /path/to/config:/root/config \
  --restart=unless-stopped \
  amazingmoaaz/askarr:latest

⁠Docker Compose

version: '3.8'
services:
  askarr:
    image: amazingmoaaz/askarr:latest
    container_name: askarr
    ports:
      - "4545:4545"
    volumes:
      - ./config:/root/config
    restart: unless-stopped

Access the web interface at: http://localhost:4545

⁠✨ Features

⁠Chat Platform Integration

⁠Media Server Support

• 📺 Sonarr - TV show management (V2-V4)
• 🎬 Radarr - Movie management (V2-V5)
• 🎵 Lidarr - Music management (V1-V2)
• 🎯 Overseerr - Request management with advanced features
• 📋 Ombi - V3/V4 compatible with quota management

⁠Key Capabilities

✅ Multi-platform chat bot support
✅ Quality profile management
✅ Automated notifications
✅ Request tracking and management
✅ Issue reporting system
✅ Multi-language support
✅ Role-based access control
✅ NEW in v2.0: Dynamic version checking with update notifications
✅ NEW in v2.0: Interactive Telegram help menu

⁠📦 Available Tags

⁠Version Selection

# Latest stable
docker pull amazingmoaaz/askarr:latest

# Specific version
docker pull amazingmoaaz/askarr:2.0.0

# Major.Minor (receives patch updates)
docker pull amazingmoaaz/askarr:2.0

⁠⚙️ Configuration

⁠Environment Variables

⁠Volume Mounts

⁠Ports

⁠🚀 Setup Guide

⁠1. First Run

On first run, Askarr will create the necessary configuration files:

docker run -d \
  --name askarr \
  -p 4545:4545 \
  -v ./askarr-config:/root/config \
  amazingmoaaz/askarr:latest

⁠2. Access Web Interface

Navigate to http://localhost:4545 and complete the setup wizard.

⁠3. Configure Chat Clients

Discord Setup:

1. Create a bot at Discord Developer Portal⁠
2. Copy Bot Token and Client ID
3. Configure in Askarr web interface
4. Invite bot to your server

Telegram Setup:

1. Create a bot with @BotFather⁠
2. Copy the bot token
3. Configure in Askarr web interface
4. Start chatting with your bot

⁠4. Connect Media Servers

Configure your Sonarr, Radarr, Lidarr, Overseerr, or Ombi instances in the web interface.

⁠📊 System Requirements

⁠Minimum Requirements

• RAM: 256 MB
• CPU: 1 core
• Storage: 100 MB
• Docker: 20.10+

⁠Recommended

• RAM: 512 MB+
• CPU: 2 cores
• Storage: 500 MB+
• Network: Stable internet connection

⁠🔄 Updating

⁠Pull Latest Version

# Stop container
docker stop askarr

# Remove old container
docker rm askarr

# Pull latest image
docker pull amazingmoaaz/askarr:latest

# Start new container
docker run -d \
  --name askarr \
  -p 4545:4545 \
  -v /path/to/config:/root/config \
  --restart=unless-stopped \
  amazingmoaaz/askarr:latest

⁠Using Docker Compose

docker-compose pull
docker-compose up -d

⁠🐛 Troubleshooting

⁠Check Logs

docker logs askarr

⁠Follow Logs in Real-time

docker logs -f askarr

⁠Access Container Shell

docker exec -it askarr /bin/bash

⁠Common Issues

Port Already in Use:

# Use a different port
docker run -d -p 5000:4545 amazingmoaaz/askarr:latest

Permission Issues:

# Check volume permissions
ls -la /path/to/config

⁠🔗 Links

• 📚 Documentation⁠
• 🐛 Report Issues⁠
• 💬 Discussions⁠
• 📋 Changelog⁠
• 🏠 GitHub Repository⁠

⁠📄 License

Askarr is licensed under the MIT License⁠.

⁠🙏 Acknowledgements

Built upon the foundation of Requestrr by @darkalfx⁠ and @thomst08⁠.