An open API service indexing awesome lists of open source software.

https://github.com/ithaquakr/stack-compose

A curated collection of production-ready Docker Compose templates for popular application stacks.
https://github.com/ithaquakr/stack-compose

containerization docker docker-compose

Last synced: 3 months ago
JSON representation

A curated collection of production-ready Docker Compose templates for popular application stacks.

Awesome Lists containing this project

README

          

> [!WARNING]
> DEPRECATED: Move all stuff to new home:

# Stack-Compose ๐Ÿณ

A curated collection of production-ready Docker Compose templates for popular
application stacks. Deploy development environments in seconds with
pre-configured services like PostgreSQL, Redis, MySQL, and more.

[![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)

## Philosophy ๐ŸŒฑ

This project is built on three core principles:

1. **Simplicity First**
Minimal configurations with sane defaults. No unnecessary abstractions or
complex tooling.

2. **Zero Black Magic**
Explicit configurations over hidden automation. You always know exactly
what's running.

3. **Modular by Design**
Mix-and-match components like LEGO blocks. Each service is self-contained
yet interoperable.

We believe in **documentation-driven development** - every template comes with
detailed setup guides and operational notes.

## Features โœจ

- ๐Ÿš€ Production-inspired configurations
- ๐Ÿ”’ Secure defaults (proper user permissions, isolated networks)
- ๐Ÿ“ Environment variable driven setups
- ๐Ÿ”„ Easy version switching
- ๐Ÿ“ˆ Optional monitoring stacks
- ๐Ÿ” Healthchecks and proper service dependencies

## Getting Started

### Prerequisites

- Docker Engine โ‰ฅ 20.10
- Docker Compose โ‰ฅ 2.17

### Basic Usage

1. Clone the repository:

```bash
git clone https://github.com/ithaquaKr/stack-compose.git
cd stack-compose
```

2. Navigate to desired component:

```bash
cd composes/postgres
```

3. Start the stack:

```bash
docker compose up -d
```

**Example - PostgreSQL + pgAdmin:**

```bash
docker compose -f docker-compose.yml -f docker-compose.pgadmin.yml up -d
```

**Example - Redis with Persistent Storage:**

```bash
docker compose -f docker-compose.yml -f docker-compose.persistence.yml up -d
```

## Repository Structure ๐Ÿ“‚

```
stack-compose/
โ”œโ”€โ”€ composes/
โ”‚ โ”œโ”€โ”€ postgres/
โ”‚ โ”‚ โ”œโ”€โ”€ docker-compose.yml
โ”‚ โ”‚ โ”œโ”€โ”€ docker-compose.pgadmin.yml # Optional extensions
โ”‚ โ”‚ โ””โ”€โ”€ README.md # Component-specific docs
โ”‚ โ”œโ”€โ”€ redis/
โ”‚ โ”œโ”€โ”€ mysql/
โ”‚ โ””โ”€โ”€ .../
โ”œโ”€โ”€ .env.example # Common environment variables
โ””โ”€โ”€ README.md # This global documentation
```

Each component includes:

- Base `docker-compose.yml` file
- Optional extension files for additional tooling
- Detailed README with:
- Service configuration details
- Connection strings
- Security considerations
- Backup/restore procedures
- Common troubleshooting steps

## Customization ๐Ÿ› ๏ธ

1. **Environment Variables**
Copy `.env.example` to `.env` and modify values:

```bash
cp .env.example .env
```

2. **Docker Compose Overrides**
Create `docker-compose.override.yml` for local customizations that won't affect upstream:

```yaml
version: "3.8"
services:
postgres:
ports:
- "5432:5432"
volumes:
- ./local-data:/var/lib/postgresql/data
```

## Contributing ๐Ÿค

We welcome contributions through:

- ๐Ÿ› Bug reports
- ๐Ÿ’ก Feature requests
- ๐Ÿ“š Documentation improvements
- ๐Ÿงช New stack components

Please read our [Contribution Guidelines](CONTRIBUTING.md) before submitting changes.

## License ๐Ÿ“„

This project is licensed under the MIT License - see the [LICENSE](LICENSE)
file for details.

## Support โค๏ธ

For help or questions:

- [Open an Issue](https://github.com/yourusername/stack-compose/issues)
- Join our [Community Discussion Forum](#) (link your preferred platform)

## Acknowledgements

- Inspired by real-world deployment patterns
- Security guidance from [CIS Docker Benchmarks](https://cisecurity.org/benchmark/docker)
- Documentation templates from [Awesome Compose](https://github.com/docker/awesome-compose)

---

**Happy Containerizing!** ๐Ÿณ + โค๏ธ = ๐Ÿ˜Š