Skip to content

stewnight/Coolify-scripts

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Coolify Compose Collection

A curated collection of Docker Compose files and documentation for use with Coolify.io - the open-source & self-hosted Heroku/Netlify alternative.

🎯 Purpose

This repository serves multiple purposes:

  1. Archive default Coolify one-click service configurations
  2. Provide custom compose files optimized for Coolify
  3. Share documentation and guides for common deployment patterns
  4. Maintain scripts and tools for Coolify management

📁 Repository Structure

.
├── coolify-defaults/     # Official Coolify one-click configurations
├── custom/              # Custom compose configurations
├── docs/                # Guides and documentation
│   ├── databases/      # Database setup guides
│   ├── deployment/     # Deployment patterns
│   └── examples/       # Example configurations
└── scripts/            # Helper scripts and tools

🚀 Getting Started

Prerequisites

  • A running Coolify instance
  • Basic understanding of Docker Compose
  • Familiarity with Coolify's UI and concepts

Using Compose Files

  1. Choose a compose file from either coolify-defaults/ or custom/
  2. Create a new service in Coolify using "Docker Compose" as the source
  3. Paste the compose configuration
  4. Configure environment variables through Coolify's UI
  5. Deploy!

📚 Compose File Standards

File Structure

Each compose file should include:

  • Header documentation with links, slogan, tags, and exposed ports
  • Required Coolify labels for service management
  • Proper service dependencies and healthchecks
  • Volume configurations for persistent data

Environment Variables

Coolify uses specific patterns for environment variables:

  • ${SERVICE_FQDN_NAME_PORT} - Service URLs and ports
  • ${SERVICE_PASSWORD_NAME} - Standard passwords
  • ${SERVICE_PASSWORD_64_NAME} - High-entropy passwords/secrets
  • ${SERVICE_USER_NAME} - Service usernames
  • ${SERVICE_SETTING_NAME} - API keys and settings
  • ${SERVICE_BASE64_NAME} - Base64 encoded values
  • ${SERVICE_REALBASE64_NAME} - True base64 encoded values

Healthchecks

All services should include standardized healthchecks:

healthcheck:
  test: ['CMD', 'command', 'args']
  interval: 5s
  timeout: 10s
  retries: 3

Security Best Practices

  • Never commit sensitive data
  • Use Coolify's variable management
  • Follow least privilege principles
  • Implement proper service isolation
  • Use secure defaults

📚 Documentation

Database Guides

Deployment Patterns

🔧 Features

  • Optimized for Coolify's UI components
  • Database backup integration
  • Service-specific configuration fields
  • Environment variable management
  • Health check implementations

🤝 Contributing

Contributions are welcome! Please read our Contributing Guide for details on:

  • Code of Conduct
  • Submission process
  • Compose file standards
  • Documentation guidelines

⚠️ Security

  • Never commit sensitive data or secrets
  • Use Coolify's UI for managing sensitive environment variables
  • Follow security best practices in compose configurations

📝 License

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

🔗 Resources

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published