First Deploy
📖 In this guide
- ✓ You will connect your project on GitHub to Skyversal.
- ✓ You will see the build and deploy settings.
- ✓ You will take your first application live to production.
Everything is ready. In this guide, you will connect your project on GitHub to Skyversal, configure the necessary settings, and complete your first deploy in just a few minutes.
📦 1. Defining the Project Source
When you click the "Add New Project" button on your dashboard, you are presented with three different source options. You should select the most suitable one based on where your project is stored:
Connect with GitHub (Recommended)
This is the most popular method. When you authorize Skyversal, you can connect your repositories. Every push to the main or master branch on GitHub can automatically trigger a new deploy. Thus, the deployment process becomes automated.
The moment you run the following command on your local machine, your code on the server is automatically updated:
git push origin mainUpload ZIP Archive
If your project only resides on your local disk, you can compress all your project files into a .zip archive and drop it directly into the panel. Skyversal extracts this archive and starts the build process.
Marketplace Templates
You can install ready-made templates such as WordPress, Ghost, Strapi, or Laravel available in the Skyversal Marketplace with a single click.
🤖 2. Smart Code Auto-Detection
Skyversal analyzes your project files and automatically detects the framework and execution environment. Necessary build and run settings are automatically prepared for supported projects. Whether you have a React, Vue, Next.js, Laravel or Python Django/FastAPI project, Skyversal scans your file structure to provide the optimal configuration. For example;
- package.json → Prepared for Node.js, Next.js, React etc. environments.
- composer.json → Laravel and PHP requirements are configured.
- Dockerfile → A custom Docker-based deployment is initiated.
🛠️ 3. Setup Modes & Database Addons
Once your project type is determined, you can select the additional services your application needs. The Skyversal interface provides 3 tabs: Quick, Pro, and Expert.
One-Click Services (Addons)
If your application requires a database or cache system, you can include the following services in your project instantly from the UI without the need to rent an external database server:
🔑 4. Environment Variables
API keys, passwords, or secret tokens should never be stored within the code. Most frameworks read these settings from .env files.
You can paste the contents of your own .env file into the Environment Variables area on the project creation screen. Environment Variables are stored securely and transferred to your application only during build and runtime.
For your security, never commit files like .env or .env.production to your GitHub repository. Manage your secret keys only through the Skyversal panel.
📋 Deploy Summary
🚀 5. Build and Deploy Process
You've set everything up and pressed that magical "Deploy" button. During the deployment, Skyversal automatically performs the following steps. You can follow all operations in real-time from the live Deploy Log screen:
- ✓ Downloads the source code
- ✓ Starts the build process
- ✓ Installs dependencies
- ✓ Injects Environment Variables
- ✓ Starts the application
- ✓ Performs health checks
- ✓ Routes traffic to the new version
When the new version successfully passes the health checks, traffic is routed to the new version. Thus, users do not experience any downtime during deployment.
❓ Did You Experience an Issue? (Common Errors)
Common errors encountered during deploy and their solutions:
E_BUILD_FAILED
An error occurred during the build phase. This could be a syntax error or a missing package. Check your Deploy Logs.
Missing Environment Variable
A variable required by your project (e.g., database password) is missing. Add the relevant variable from the settings tab and re-deploy.
If you cannot find the source of the error, here are general troubleshooting steps:
- Examine the Deploy Log screen to understand the source of the error.
- Ensure that the necessary build commands for your framework are configured correctly.
- Check that your Environment Variables settings are complete and correct.
- Take a look at the supported framework list and custom build settings.
- Do not hesitate to Contact our Support Team for issues you cannot solve.
🎉 Congratulations, You're Live!
Your application is now live on the internet.
In the next guide, you will connect your custom domain and enable Skyversal's automatic SSL support.
➜ Add Custom Domain