mirror of
https://github.com/biersoeckli/QuickStack.git
synced 2026-02-11 05:59:23 -06:00
44 lines
2.3 KiB
Markdown
44 lines
2.3 KiB
Markdown
|
|
|
|
<img src="/public/quickstack-repo-heading.png" alt="QuickStack Logo" width="100%" />
|
|
|
|
QuickStack is a self-hosted PaaS solution designed to simplify the management of your applications on one or more virtual private servers (VPS).
|
|
|
|
Developed as part of a student project by [glueh-wyy-huet](https://github.com/glueh-wyy-huet) and [biersoeckli](https://github.com/biersoeckli) at the [Eastern Switzerland University of Applied Sciences](https://ost.ch/), QuickStack provides a scalable and cost-effective alternative to commercial cloud PaaS offerings like Vercel, Digital Ocean App Platform or Azure App Service.
|
|
|
|
<img src="/github-assets/app-settings-general.png" alt="QuickStack App Settings Image" width="100%" />
|
|
|
|
## Key Features
|
|
|
|
* **One-Command Installation:** Deploy QuickStack on a VPS with a single command.
|
|
* **Git Integration:** Deploy applications directly from public or private Git repositories.
|
|
* **Docker Container Deployment:** Deploy Docker containers from a Docker Hub, a public or a private registry.
|
|
* **Live Logging:** Debug running containers with live log streams.
|
|
* **Web Terminal:** Access a web-based terminal directly within the container for debugging.
|
|
* **SSL Certificate Management:** Automatic SSL certificate generation via Let's Encrypt.
|
|
* **Resource Management:** Set resource limits (CPU, RAM, storage) for each application.
|
|
* **Monitoring Dashboard:** Track resource consumption and application performance.
|
|
* **Backups:** Create backups of application data and databases to a S3-compatible storage.
|
|
* **Cluster Support:** Scale applications across multiple VPS nodes.
|
|
* **Persistent Storage:** Cluster-wide persistent storage volumes for applications.
|
|
|
|
## Getting Started
|
|
### Prerequisites
|
|
Before getting started, ensure that you have:
|
|
* A new virtual private server (VPS) running a Linux distribution (Ubuntu preferred).
|
|
|
|
### Installation
|
|
1. **Connect to your VPS via SSH.**
|
|
2. **Run the setup script:**
|
|
```bash
|
|
curl -sfL https://get.quickstack.dev/setup.sh | sh -
|
|
```
|
|
|
|
Visit our [docs](https://quickstack.dev/docs/intro) for more detailed installation instructions:
|
|
|
|
## Contributing
|
|
Contributions are welcome! Further information on how to contribute can be found in the [CONTRIBUTING.md](CONTRIBUTING.md) file.
|
|
|
|
## License
|
|
This project is licensed under the GPL-3.0 license.
|