Files
dokploy/README.md
T

138 lines
6.6 KiB
Markdown
Raw Normal View History

2024-06-15 04:02:24 -06:00
<div align="center">
<div>
2024-09-13 13:54:03 -06:00
<a href="https://dokploy.com" target="_blank" rel="noopener">
<img style="object-fit: cover;" align="center" width="100%"src=".github/sponsors/logo.png" alt="Dokploy - Open Source Alternative to Vercel, Heroku and Netlify." />
</a>
2024-06-15 04:02:24 -06:00
</div>
2024-06-15 04:08:32 -06:00
2024-07-31 00:46:51 -06:00
</br>
<div align="center">
<div>Join us on Discord for help, feedback, and discussions!</div>
</br>
2024-08-27 13:46:09 -06:00
<a href="https://discord.gg/2tBnJ3jDJc">
2024-07-31 00:46:51 -06:00
<img src="https://discordapp.com/api/guilds/1234073262418563112/widget.png?style=banner2" alt="Discord Shield"/>
</a>
</div>
2024-05-12 09:53:26 +08:00
</div>
2024-06-15 04:08:32 -06:00
<br />
Dokploy is a free, self-hostable Platform as a Service (PaaS) that simplifies the deployment and management of applications and databases.
2024-05-12 09:53:26 +08:00
2024-06-15 04:01:35 -06:00
### Features
2024-05-12 09:55:11 +08:00
Dokploy includes multiple features to make your life easier.
2024-06-15 04:02:24 -06:00
2024-07-13 00:48:49 -06:00
- **Applications**: Deploy any type of application (Node.js, PHP, Python, Go, Ruby, etc.).
- **Databases**: Create and manage databases with support for MySQL, PostgreSQL, MongoDB, MariaDB, and Redis.
- **Backups**: Automate backups for databases to an external storage destination.
2024-07-13 00:48:49 -06:00
- **Docker Compose**: Native support for Docker Compose to manage complex applications.
- **Multi Node**: Scale applications to multiple nodes using Docker Swarm to manage the cluster.
- **Templates**: Deploy open-source templates (Plausible, Pocketbase, Calcom, etc.) with a single click.
2024-07-13 00:48:49 -06:00
- **Traefik Integration**: Automatically integrates with Traefik for routing and load balancing.
- **Real-time Monitoring**: Monitor CPU, memory, storage, and network usage for every resource.
2024-07-13 00:48:49 -06:00
- **Docker Management**: Easily deploy and manage Docker containers.
2024-10-23 20:18:59 -04:00
- **CLI/API**: Manage your applications and databases using the command line or through the API.
- **Notifications**: Get notified when your deployments succeed or fail (via Slack, Discord, Telegram, Email, etc.).
- **Multi Server**: Deploy and manage your applications remotely to external servers.
2024-07-13 00:48:49 -06:00
- **Self-Hosted**: Self-host Dokploy on your VPS.
2024-05-12 09:53:26 +08:00
## 🚀 Getting Started
To get started, run the following command on a VPS:
2024-05-12 09:53:26 +08:00
2024-11-10 00:28:27 -06:00
Want to skip the installation process? [Try the Dokploy Cloud](https://app.dokploy.com).
2024-05-12 09:53:26 +08:00
```bash
curl -sSL https://dokploy.com/install.sh | sh
```
2024-06-15 04:01:35 -06:00
For detailed documentation, visit [docs.dokploy.com](https://docs.dokploy.com).
2024-07-29 23:08:23 -06:00
## Sponsors
2024-07-13 00:48:49 -06:00
2024-07-29 23:08:23 -06:00
🙏 We're deeply grateful to all our sponsors who make Dokploy possible! Your support helps cover the costs of hosting, testing, and developing new features.
[Dokploy Open Collective](https://opencollective.com/dokploy)
2024-06-15 04:01:35 -06:00
2024-07-29 23:08:23 -06:00
[Github Sponsors](https://github.com/sponsors/Siumauricio)
2024-06-15 04:01:35 -06:00
2024-07-29 23:08:23 -06:00
<!-- Hero Sponsors 🎖 -->
2024-06-15 04:01:35 -06:00
2024-07-29 23:08:23 -06:00
<!-- Add Hero Sponsors here -->
2024-06-15 04:02:24 -06:00
2024-08-30 11:06:33 -06:00
### Hero Sponsors 🎖
2024-10-12 23:03:09 +02:00
<div style="display: flex; align-items: center; gap: 20px;">
2025-07-03 08:41:38 +09:00
<a href="https://www.hostinger.com/vps-hosting?ref=dokploy" target="_blank" style="display: inline-block; margin-right: 10px;"><img src=".github/sponsors/hostinger.jpg" alt="Hostinger" height="50"/></a>
<a href="https://www.lxaer.com/?ref=dokploy" target="_blank" style="display: inline-block; margin-right: 10px;"><img src=".github/sponsors/lxaer.png" alt="LX Aer" height="50"/></a>
<a href="https://mandarin3d.com/?ref=dokploy" target="_blank" style="display: inline-block;"><img src=".github/sponsors/mandarin.png" alt="Mandarin" height="50"/></a>
<a href="https://lightnode.com/?ref=dokploy" target="_blank" style="display: inline-block;"><img src=".github/sponsors/light-node.webp" alt="Lightnode" height="70"/></a>
2024-10-12 23:03:09 +02:00
</div>
2024-08-30 11:06:33 -06:00
2024-07-29 23:08:23 -06:00
### Premium Supporters 🥇
<div style="display: flex; align-items: center; gap: 20px;">
2025-07-03 08:41:38 +09:00
<a href="https://supafort.com/?ref=dokploy" target="_blank" style="display: inline-block; margin-right: 20px;"><img src="https://supafort.com/build/q-4Ht4rBZR.webp" alt="Supafort.com" height="50"/></a>
<a href="https://agentdock.ai/?ref=dokploy" target="_blank" style="display: inline-block; margin-right: 50px;"><img src=".github/sponsors/agentdock.png" alt="agentdock.ai" height="70"/></a>
2025-05-05 02:58:52 -06:00
</div>
### Elite Contributors 🥈
<div style="display: flex; align-items: center; gap: 20px;">
2025-07-03 08:41:38 +09:00
<a href="https://americancloud.com/?ref=dokploy" target="_blank" style="display: inline-block; padding: 10px; border-radius: 10px;"><img src=".github/sponsors/american-cloud.png" alt="AmericanCloud" height="70"/></a>
<a href="https://tolgee.io/?utm_source=github_dokploy&utm_medium=banner&utm_campaign=dokploy" target="_blank" style="display: inline-block; margin-right: 10px;"><img src="https://dokploy.com/tolgee-logo.png" alt="Tolgee" height="80"/></a>
</div>
2024-07-29 23:08:23 -06:00
<!-- Elite Contributors 🥈 -->
2024-07-29 23:08:23 -06:00
<!-- Add Elite Contributors here -->
2024-06-15 04:01:35 -06:00
2024-07-29 23:08:23 -06:00
### Supporting Members 🥉
2024-06-15 04:01:35 -06:00
2024-07-29 23:08:23 -06:00
<div style="display: flex; gap: 30px; flex-wrap: wrap;">
2024-08-01 09:12:25 -06:00
<a href="https://lightspeed.run/?ref=dokploy"><img src="https://github.com/lightspeedrun.png" width="60px" alt="Lightspeed.run"/></a>
2024-11-17 22:25:03 -06:00
<a href="https://cloudblast.io/?ref=dokploy "><img src="https://cloudblast.io/img/logo-icon.193cf13e.svg" width="250px" alt="Cloudblast.io"/></a>
<a href="https://startupfa.me/?ref=dokploy "><img src=".github/sponsors/startupfame.png" width="65px" alt="Startupfame"/></a>
2025-01-03 16:19:48 -06:00
<a href="https://itsdb-center.com?ref=dokploy "><img src=".github/sponsors/its.png" width="65px" alt="Itsdb-center"/></a>
2025-02-09 03:17:13 -06:00
<a href="https://openalternative.co/?ref=dokploy "><img src=".github/sponsors/openalternative.png" width="65px" alt="Openalternative"/></a>
<a href="https://synexa.ai/?ref=dokploy"><img src=".github/sponsors/synexa.png" width="65px" alt="Synexa"/></a>
2024-07-29 23:08:23 -06:00
</div>
2024-07-29 23:08:23 -06:00
### Community Backers 🤝
<div style="display: flex; gap: 30px; flex-wrap: wrap;">
2024-08-01 09:12:25 -06:00
<a href="https://steamsets.com/?ref=dokploy"><img src="https://avatars.githubusercontent.com/u/111978405?s=200&v=4" width="60px" alt="Steamsets.com"/></a>
2024-10-11 11:21:20 +02:00
<a href="https://rivo.gg/?ref=dokploy"><img src="https://avatars.githubusercontent.com/u/126797452?s=200&v=4" width="60px" alt="Rivo.gg"/></a>
2024-10-25 10:20:56 -06:00
<a href="https://photoquest.wedding/?ref=dokploy"><img src="https://photoquest.wedding/favicon/android-chrome-512x512.png" width="60px" alt="Rivo.gg"/></a>
2024-07-29 23:08:23 -06:00
</div>
#### Organizations:
[![Sponsors on Open Collective](https://opencollective.com/dokploy/organizations.svg?width=890)](https://opencollective.com/dokploy)
2024-06-15 04:01:35 -06:00
2024-07-29 23:08:23 -06:00
#### Individuals:
2024-06-15 04:01:35 -06:00
2024-07-29 23:08:23 -06:00
[![Individual Contributors on Open Collective](https://opencollective.com/dokploy/individuals.svg?width=890)](https://opencollective.com/dokploy)
### Contributors 🤝
2024-06-15 04:02:24 -06:00
<a href="https://github.com/dokploy/dokploy/graphs/contributors">
<img src="https://contrib.rocks/image?repo=dokploy/dokploy" />
2024-07-29 23:08:23 -06:00
</a>
## Video Tutorial
<a href="https://youtu.be/mznYKPvhcfw">
2024-11-18 22:25:56 +08:00
<img src="https://dokploy.com/banner.png" alt="Watch the video" width="400" style="border-radius:20px;"/>
2024-06-15 04:02:24 -06:00
</a>
2024-07-29 23:08:23 -06:00
## Contributing
2024-05-12 09:53:26 +08:00
2024-07-29 23:08:23 -06:00
Check out the [Contributing Guide](CONTRIBUTING.md) for more information.