ajnart/dcm

Live Demo 🚀 • Install 💻 • Contribute 🤝 • Supported Tools 📦 • Screenshots 📸

📋 About

[!NOTE] 🌟 Community-Driven Project: DCM started as a simple tool but aims to become the go-to resource for Docker Compose configurations, powered by the community. We believe everyone has their favorite self-hosted tools, and we'd love for you to share yours! Whether you're using a popular application or a hidden gem, your contribution helps others discover and easily deploy great software.

DCM (Docker Compose Maker) is a simple yet powerful tool that helps you create docker-compose.yaml files for your self-hosted applications. Select from a curated list of popular containers and generate a ready-to-use configuration file with just a few clicks.

No more copy-pasting from documentation or trying to remember the correct configuration options - this tool makes it easy to set up your Docker environment.

[!TIP] Most containers come pre-configured with best practices and sensible defaults, saving you hours of documentation reading and configuration tweaking.

💡 Share Your Stack: Using a great tool that's not listed here? We'd love to include it! Check out our contribution guide to help others discover and use your favorite containers.

🔧 How to Use DCM

Using Docker Compose Maker is simple and intuitive:

1. Select containers - Browse the curated list of self-hosted applications and click to select the ones you want to include
2. Use templates - Choose from predefined templates in the Template Gallery for common stacks like media servers
3. Configure settings - Adjust environment variables, paths, and other common settings
4. Generate your configuration - Click "Copy Compose" to view and customize your docker-compose.yaml
5. Deploy your stack - Use one of the following methods to deploy your containers:

[!IMPORTANT] All containers are configured to use environment variables like ${PUID}, ${PGID}, and ${TZ}. Make sure to set these in your deployment to avoid permission issues.

Deployment Options

Once you have your docker-compose configuration, you have several ways to deploy it:

Copy & Paste

Simply copy the generated docker-compose.yaml and .env content, save them locally, and run docker-compose up -d to start your containers.

Download Files

Download the generated docker-compose.yaml and .env files directly from the interface, then use them with your preferred Docker management tool.

[!NOTE] The downloaded .env file contains all the environment variables referenced in your docker-compose.yaml. Keep both files in the same directory when deploying.

Portainer Stacks

If you're already using Portainer to manage your Docker environment, you can easily deploy your configuration as a stack:

1. Navigate to your Portainer dashboard and select Stacks from the sidebar
2. Click Add stack
3. Give your stack a name
4. Select Web editor and paste the generated docker-compose content
5. (Optional) Add the environment variables from the .env file
6. Click Deploy the stack

[!CAUTION] When using Portainer Stacks, you'll need to manually add the environment variables or upload the .env file, as Portainer doesn't automatically read the .env file in all configurations.

Using Portainer provides a user-friendly web interface to manage, update, and monitor your containers without needing command-line tools.

Other Docker Management Tools

The generated compose file works with any tool that supports docker-compose syntax, such as Docker Desktop, Rancher, Yacht, or command-line tools.

🚀 Quick Start

If you want to try DCM for yourself, there are several ways to get started:

🌐 Use the Online Version

Visit compose.ajnart.dev to use the tool immediately without installation.

[!NOTE] The online version includes analytics for usage tracking, while the self-hosted version does not.

🐳 Run with Docker

Run with a single command:

docker run -p 7576:7576 --name dcm --rm ghcr.io/ajnart/dcm

Then visit http://localhost:7576 in your browser.

The Docker image is available for multiple platforms:

• linux/amd64
• linux/arm64
• linux/arm/v7

📦 Using Docker Compose

Create a docker-compose.yaml file:

services:
  dcm:
    image: ghcr.io/ajnart/dcm
    container_name: dcm
    ports:
      - "7576:7576"
    restart: unless-stopped

Then run:

docker-compose up -d

🛠️ Build from Source

1. Clone the repository:

git clone https://github.com/ajnart/dcm.git
cd dcm

1. Install dependencies:

First install Bun if you haven't already, then run:

bun install

[!WARNING] Using npm instead of Bun may result in longer installation times and potential compatibility issues. We strongly recommend using Bun for development.

1. Build and start:

bun run build
bun start

🧰 Supported Tools

DCM includes configuration for many popular self-hosted applications, including:

📺 Media Management:

• Media Servers: Jellyfin, Plex, Emby
• Media Automation: Sonarr, Radarr, Lidarr, Readarr, Prowlarr, Bazarr, Whisparr
• Media Requests: Jellyseerr, Overseerr, Doplarr, Requestrr

🔍 Dashboards & Management:

• Dashboards: Homarr, Heimdall
• Container Management: Portainer
• Media Analytics: Tautulli

📥 Download Management:

• Torrent: qBittorrent
• Usenet: NZBGet, NZBHydra 2
• Indexers: Jackett, Prowlarr

🗄️ Databases:

• SQL: MariaDB, MySQL, PostgreSQL
• NoSQL: MongoDB, Redis

📊 Monitoring & Automation:

• Monitoring: Grafana, Prometheus
• Updates: Watchtower
• Home Automation: Home Assistant

🔐 Security: Vaultwarden

💾 Storage & Files: Nextcloud

Each tool includes a detailed description, GitHub star count, and pre-configured docker-compose settings.

🧪 Testing

DCM uses Bun for testing. To run the tests:

# Run all tests
bun test

# Run Docker Compose validation tests
bun test:compose

# Run container schema validation tests
bun test:containers

🔄 Template Gallery

DCM includes a Template Gallery that allows you to quickly add predefined stacks of containers based on common use cases:

• Media Server Stacks: Complete media server setups with Jellyfin/Plex and related tools
• Development Environments: Web development stacks with databases and web servers
• Monitoring Solutions: Grafana, Prometheus, and other monitoring tools
• Database Clusters: Various database engines with management tools
• Security Tools: Password managers and security-related containers
• And more!: Smart home hubs, personal cloud solutions, and other useful templates

To use the Template Gallery:

1. Click the "Template Gallery" button at the top of the main page
2. Browse or search for templates that match your needs
3. Click "Use Template" to add all containers from that template to your selection
4. Return to the main page to customize your selected containers

You can combine multiple templates to create your perfect self-hosted environment!

🖼️ Screenshots

User Interface

Generated docker compose file

🤝 Contributing

We welcome contributions to DCM! Whether you want to add new container definitions, improve documentation, or fix bugs, your help is appreciated.

Please check our CONTRIBUTING.md guide for detailed instructions on:

• How to add new container definitions
• Code style guidelines
• Testing requirements
• Pull request process

The easiest way to contribute is by adding new container definitions to our growing collection!

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

💖 Support

If you find this tool useful, consider supporting the project by:

• ⭐ Starring the repository on GitHub
• 🐦 Sharing it on social media
• ☕ Buying me a coffee

📞 Contact

• GitHub: @ajnart

---

Made with ❤️ by ajnart