Skip to content

Latest commit

 

History

History
101 lines (79 loc) · 4.39 KB

README.md

File metadata and controls

101 lines (79 loc) · 4.39 KB
Raw

Website • Releases • Documentation

Meet Ctrlplane, an open-source deployment tool that automates multi-cloud, multi-region, and multi-service software deployments.

⚡ Installation

The easiest way to get started with Ctrlplane is by creating a Ctrlplane Cloud account.

If you would like to self-host Plane, please see our deployment guide.

Installation methods Docs link
Docker Docker
Kubernetes Kubernetes

🚀 Features

  • Unified Control: Centralize management of multi-stage deployment pipelines across diverse environments.
  • Flexible Resource Support: Deploy to Kubernetes, cloud functions, VMs, or custom infrastructure from a single platform.
  • Advanced Workflow Orchestration: Automate sophisticated deployment processes including testing, code analysis, security scans, and approval gates.
  • CI/CD Integration: Seamlessly connects with Jenkins, GitLab CI, GitHub Actions, and other popular CI tools to trigger deployments.
  • Environment Management: Efficiently handle transitions between dev, test, staging, and production environments.

🛠️ Quick start for contributors

Development system must have docker engine installed and running.

  1. Clone the code locally using: 
    git clone https://github.com/ctrlplanedev/ctrlplane.git
  2. Switch to the code folder: 
    cd ctrlplane
  3. Create your feature or fix branch you plan to work on using: 
    git checkout -b <feature-branch-name>
  4. Open the code on VSCode or similar equivalent IDE.
  5. Copy .env.example to .env files available in various folders.
  6. Run the docker command to initiate services: 
    docker compose -f docker-compose.yaml up -d
  7. Run pnpm db:push to push the schema to the database.
  8. Run pnpm dev to start the development server.

You are ready to make changes to the code. Do not forget to refresh the browser (in case it does not auto-reload).

Thats it!

❤️ Community

The Ctrlplane community can be found on GitHub Discussions, and our Discord server

Ask questions, report bugs, join discussions, voice ideas, make feature requests, or share your projects.

⛓️ Security

If you believe you have found a security vulnerability in Plane, we encourage you to responsibly disclose this and not open a public issue. We will investigate all legitimate reports.

Email [email protected] to disclose any security vulnerabilities.

We couldn't have done this without you.