Deploy from GitHub

Creating an application in ServerAvatar for hosting PHP scripts and projects with Git is simple. You can specify the application name, domain, system user, and other options such as PHP version and custom web root. When choosing the deployment method, you can select "Git" to easily deploy your PHP code from a Git repository. Once the application is created, ServerAvatar will automatically clone the repository and deploy the code. You can manage the Git deployment process from the ServerAvatar dashboard. ServerAvatar makes it easy to create and manage PHP applications with Git.

Once you have connected your server with ServerAvatar, you can follow the steps below to automatically install the GitLab repository on your server.

Github integration

Step 1: First, you need to Integrate Git, Navigate to Dashboard → Integration → Git.

Step 2: Click on the Github Link Github button like the below image. After that, allow authorisation to serveravatar for deploying your project and your Github account connected with the serveravatar account.

Step 3: Now, you can deploy a site from Github.

Create Application

Step 1: Click on the server on which you want to create the new application.

Step 2: Now, you will see the option Applications on the left-hand sidebar of the Server Panel. Click on Applications.

Step 3: Now, you will see the Applications table like the below image. Click on the Create button on the top right of the Applications table, as mentioned in the below image.

Step 4: After that, you will see the Create Application screen like the below image.

Step 5: Basic Details

• Enter the name of your application in the Application Name field.
• Choose whether you want to use a primary domain or a test domain in the Domain field. If you select a test domain, you can change it later to a primary domain.
• Click on the Next button.

Step 6: Application

• Choose the method Git to deploy using git.

  • In the Git method, you have to select the Git provider as Github.

    

  • If your repository Type is Public, then enter Clone HTTP Url, Branch. If you want to run a script after cloning your repository, then write a deployment script. Then click on the Next Step button.

    

  • If your repository Type is Private, then first, you need to Generate ssh-key for deployment and Copy that ssh-key to put into the Github account,

    

  • Login into your Integrated Github account, and Navigate to Settings → SSH and GPG keys → New SSH key.

  • Enter Title and Paste your Generated ssh-key as shown in the image below.

  • Then click on the Add SSH key button.

    

After that, select Integrated account, then select your repository Repository, and select its Branch. If you want to run a script after cloning your repository, then write a deployment script.

Click on the Next Step button.

Step 7: System User

When creating a new application in ServerAvatar, you have the option to either create a new system user for the application or use an existing one. A system user is a user account created on your server, which is used to manage files and permissions for your application.

Step 8: Other Setting

In the Basic Settings section of creating an application in ServerAvatar, you have the option to select the PHP version for your application. ServerAvatar supports multiple PHP versions ranging from 7.2 to 8.2. You can choose the desired PHP version for your application.

You also have the option to specify a custom webroot path for your application. By default, ServerAvatar sets the webroot path to "/public_html" for your application. However, if you want to set a custom webroot path, you can do so by entering the desired path in the "Webroot" field provided. This can be useful if you have specific requirements for the directory structure of your application.

Step 8: Review

After completing the previous steps, the user will be directed to the review page where they can review all the details they have entered for the application. This includes the application name, primary domain, test domain, application method, system user, PHP version, and custom web root path.

If any changes are required, the user can go back to the respective sections and make the changes. If everything looks good, they can click on the "Create Application" button to create the application. your website must be live in next 10-15 seconds. Once your application is installed, you will be redirected to an application dashboard from which you can manage the application.

info

You can not perform Enable Auto Pull if your repository Type is public.

Step 9: If you want to Enable Auto Pull, then navigate to Created Application Dashboard → Git.

• Then click on Enable as shown in the image below.

• After that, Copy Webhook URL.

• Login into your Integrated Github account, and In your Selected repository, navigate to Settings → Webhooks → Add webhook, and use the following settings:

  • Payload URL: Your Copied Webhook URL
  • Content type: application/json
  • SSL Verification: Disable (not recommended)
  • Which events would you like to trigger this webhook?: Just the push event
  • Active:: Check

• Click Add Webhook to save your settings, and the request should start working.

• Click on Edit, then click on Recent Deliveries tab for see your Request logs.

Step 9.1: You can view your commit history in the Webhook History section.

Step 10: To check out a branch, click on Change Branch and select the desired branch.

Step 11: If you wish to run a Custom script after a pull request, enter the script in the Deployment Script section and click Save.

• When the webhook receives a push request, you may want to execute a Custom Script to clear cache or update your web application. You can write a script that includes this command in the Deployment Script section.

info

Please use # (hashtag) for commenting in the Deployment Script.

• The script will run inside your application's root folder. If your deployment script involves using composer or PHP command, it will use the default PHP-CLI. You must use a replacer to run a script using a different PHP version.

  Replacer

  • A replacer lets you specify a specific PHP version for the deployment script to run.

  • For example: {PHP70} artisan cache:clear

  • Will be translated to: /usr/bin/php7.0 artisan cache:clear

  • You can always type the full path to the PHP version if you prefer not to use a replacer.