kamal README

The project's README from github.com/basecamp/kamal. As one markdown file: README.md.

Kamal: Deploy web apps anywhere

From bare metal to cloud VMs, deploy web apps anywhere with zero downtime. Kamal uses kamal-proxy to seamlessly switch requests between containers. Works seamlessly across multiple servers, using SSHKit to execute commands. Originally built for Rails apps, Kamal will work with any type of web app that can be containerized with Docker.

➡️ See kamal-deploy.org for documentation on installation, configuration, and commands.

Contributing to the documentation

Please help us improve Kamal's documentation on the basecamp/kamal-site repository.

License

Kamal is released under the MIT License.

kamal (basecamp/kamal)

Searching Database…

14.7K ·GitHub
What is this?Kamal is a deployment tool that lets you ship web apps packaged as Docker containers to any server, from bare metal machines to cloud VMs, with zero downtime.
Is this a hosting platform or something I run myself?It is a command-line tool you run from your own machine; it connects to your servers over SSH and orchestrates Docker containers there using SSHKit rather than hosting anything itself.
How do I actually deploy an app with it?The README points to the dedicated docs site for installation, configuration, and the deploy commands rather than listing them inline.
Do I need Docker and SSH access to my servers?Yes — your app gets containerized with Docker, Kamal uses SSHKit to run commands on your servers over SSH, and kamal-proxy routes traffic between containers during deploys.
Does it only work with Rails apps?No — it was originally built for Rails but works with any web app that can be containerized with Docker.
Is it free to use?Yes, Kamal is open source and released under the MIT License.
What is kamal-proxy?It is Kamal's companion proxy that switches incoming requests between the old and new containers during a deploy, which is how it achieves zero downtime.
Can I deploy to multiple servers at once?Yes, Kamal is designed to work seamlessly across multiple servers, using SSHKit to run commands on each of them.
Creator
basecamp
Size
3.2 MB
Stars
14.7K
Age
3y
Commits · 90 Days