67 lines
2.2 KiB
Markdown
67 lines
2.2 KiB
Markdown
<h1 align="center">
|
|
<br>
|
|
<a href="https://orus-dev.netlify.app/projects"><img src="public/dockship.svg" alt="Dockship" width="350"></a>
|
|
<br>
|
|
Dockship
|
|
<br>
|
|
</h1>
|
|
|
|
<h4 align="center">A powerful self-hosted Deployment Platform</h4>
|
|
|
|
<p align="center">
|
|
<a href="#key-features">Key Features</a> •
|
|
<a href="#installation">Installation</a> •
|
|
<a href="#license">License</a>
|
|
</p>
|
|
|
|
|
|
|
|
## Key Features
|
|
|
|
#### Core Deployment
|
|
|
|
- **Easy Deployment** - Deploy Dockerized applications in just a few clicks. Provide your app name, repository, and Docker image, and Dockship handles the rest.
|
|
- **Docker Integration** - Pull and run images from any registry. Validate Dockerfiles and optionally build images from repositories.
|
|
|
|
#### Application Management
|
|
|
|
- **App Management** - Start, stop, restart, and remove applications from the dashboard. Track running containers and deployed images easily.
|
|
- **Real-Time Logs & Monitoring** - Stream container logs in real-time and monitor CPU, memory, and disk usage for each node.
|
|
|
|
#### Multi-Node & Scaling
|
|
|
|
- **Multi-Node Support** - Manage multiple nodes in your infrastructure. Deploy applications across nodes and monitor them centrally.
|
|
- **Extensible Architecture** - Each application stores its metadata and Docker image reference, making builds, redeployments, and future scaling simple.
|
|
|
|
#### Security & User Experience
|
|
|
|
- **Secure Access** - Authenticate users to ensure only authorized personnel can deploy and manage applications.
|
|
- **User-Friendly Dashboard** - Clean and responsive UI with light/dark mode support. Quickly see all apps, their status, and node assignments.
|
|
|
|
#### Future Features
|
|
|
|
- Git integration and automatic builds
|
|
|
|
## Installation
|
|
|
|
#### Dependencies
|
|
|
|
- [Git](https://git-scm.com)
|
|
- [Docker](https://www.docker.com)
|
|
- [Node.js](https://nodejs.org/en/download/)
|
|
|
|
**Being in the home directory is recommended**
|
|
|
|
```bash
|
|
git clone https://github.com/orus-dev/dockship.git && cd dockship && bash installer.sh
|
|
```
|
|
|
|
## License
|
|
|
|
MIT
|
|
|
|
> Website [orus-dev.app](https://orus-dev.netlify.app) ·
|
|
> GitHub [@orus-dev](https://github.com/orus-dev)
|
|
|
|
Huge thank you to [@amitmerchant1990](https://github.com/amitmerchant1990) for making this readme template
|