Detailed explanation of the steps to deploy Github projects to the server

Github is currently the largest open source community in the world. Many programmers will host their own code on Github to take advantage of its convenient version control and collaboration functions. However, the project on Github is just code, and deploying it to the server for running requires some extra work. This article will introduce you to the specific steps.

1. Log in to the server

Use SSH to connect remotely and enter the command:

ssh root@your_server_ip

2. Install the necessary software

Install Git and Node.js on the server. Taking the Ubuntu system as an example, execute the following command:

sudo apt-get update
sudo apt-get install git
sudo apt-get install nodejs

3. Create a Git repository on the server

Create an empty directory on the server and put it in it Initialize a Git repository and execute the following command:

mkdir myapp
cd myapp
git init --bare

4. Set up Git Hooks

Add a post-receive hook in the Git repository to automatically deploy the application, execute The following command:

cd hooks
touch post-receive
sudo chmod +x post-receive
nano post-receive

Enter the following content in the open text editor:

#!/bin/bash
git --work-tree=/var/www/html/myapp --git-dir=/root/myapp.git checkout -f
cd /var/www/html/myapp
sudo npm install

The script will automatically check out the code to /var/www/html/myapp and execute npm install command to install project dependencies.

5. Configure Webhooks on Github

Log in to Github, click the Webhooks option in the project's Settings page, and then click the Add webhook button. Enter the server's IP address and the path of the post-receive hook in the Payload URL, for example: http://your_server_ip:8000/hooks/post-receive. Select application/json in Content type and click Add webhook.

6. Add the server address in the local code

Modify the package.json file in the local code and add the following content:

{
  "scripts": {
    "start": "node app.js",
    "deploy": "git push deploy master"
  },
  "config": {
    "deploy": {
      "production": {
        "user": "root",
        "host": "your_server_ip",
        "ref": "origin/master",
        "repo": "ssh://git@your_server_ip:/root/myapp.git",
        "path": "/var/www/html/myapp",
        "ssh_options": ["StrictHostKeyChecking=no", "PasswordAuthentication=no"],
        "post-deploy": "npm install && pm2 restart app"
      }
    }
  }
}

Among them, the deploy script will push the code to the myapp.git warehouse on the server; some configuration items are defined in config/deploy/production, including the IP address of the server, the path of the project, the path of the hook, etc.

7. Execute code deployment

Execute the following command in the local code directory:

npm run deploy production

This command will push the code to the server and trigger The post-receive hook automatically deploys the code to the /var/www/html/myapp directory.

8. Start the application

Go to the /var/www/html/myapp directory and execute the following command to start the application:

npm start

The application should now run on the server! If the application fails to start, you need to check that the dependencies are installed correctly and that the application is configured correctly.

Summary:

The above are the steps to deploy the project on Github to the server. Although this process may seem tedious, using this approach allows for efficient code deployment and collaboration. At the same time, it also provides us with great learning opportunities, allowing us to have a deeper understanding of Git, Node.js and other technologies.

The above is the detailed content of Detailed explanation of the steps to deploy Github projects to the server. For more information, please follow other related articles on the PHP Chinese website!