Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 1.25 KB

getting-started.md

File metadata and controls

47 lines (31 loc) · 1.25 KB

Getting Started

Requirements

  • Unraid 6.9.0 or later
  • Docker service enabled

Installation

Via Community Applications (NOT YET AVAILABLE)

  1. Open the Apps tab in Unraid
  2. Search for "Compose Manager"
  3. Click Install

Manual Installation

  1. Navigate to Plugins → Install Plugin
  2. Enter the plugin URL: 
    https://raw.githubusercontent.com/mstrhakr/compose_plugin/main/compose.manager.plg
  3. Click Install

First Steps

After installation:

  1. Navigate to Docker → Compose in the Unraid web UI
  2. Click Add Stack to create your first compose stack
  3. Enter a name for your stack
  4. Edit the compose.yaml file using the built-in editor
  5. Click Compose Up to start your stack

Compose Manager Interface

Dashboard Widget

Compose Manager adds a widget to your Unraid dashboard showing stack status at a glance.

Dashboard Widget

Next Steps

  • User Guide - Learn about all the features
  • Configuration - Customize your settings
  • Backup & Restore - Configure backups and restores via Settings → Compose → Backup / Restore (manual and scheduled options)