[{"template":"item","lang":"en","langs":["en","zh-CN"],"summary":{"raw":"Many applications store data in texts, such as the Beancount, or some static blogs. This data is ideal for versioning with git. However, after you push your changes locally, you need to pull them somewhere else. This article uses Webhook to automate this process.","html":"

Many applications store data in texts, such as the Beancount, or some static blogs. This data is ideal for versioning with git. However, after you push your changes locally, you need to pull them somewhere else. This article uses Webhook to automate this process.

\n"},"visible":true,"routable":true,"title":"Using Webhook to Automatically Pull Code","comment":{"enabled":true,"reply":true},"discuss":{"enabled":true},"keywords":["Webhook Getting Started","Webhook Usage","Automatically Pull Code","Webhook Config","Webhook yaml"],"webmention":{"enabled":true,"accept":true,"callback":{"secret":{"hash":{"sha256":"44bb9da44b424c6dfc9233819e907029ff2ccdfaa89919d3696ddf8db7ff6647"}}}},"pingback":{"enabled":true,"accept":true},"slug":"webhook-to-git-pull-from-forgejo","taxonomy":{"category":["Software"],"tag":["Webhook","Git","Forgejo","Beancount"],"series":[]},"route":"/webhook-to-git-pull-from-forgejo/","toc":{"enabled":true},"published":{"date":"2023-05-31 05:31"},"modified":{"date":"2024-04-18T10:03:42.262Z"},"data":{},"license":"CC-BY-SA-4.0","author":[{"email":{"value":{"encrypted":"ODgyZjdiZDg4OTVmMjllOGZkNmFmYg==","algorithm":"aes-256-gcm","iv":"067f6d66f2ba5dd50c8443be"},"hash":{"md5":"8770854a9222b6bf1ee195220793bcf1"}},"url":"https://dallas.lu","name":"Dallas Lu","lang":"en","user":"dallaslu"}],"contributor":[],"sponsor":[],"image":[],"audio":[],"video":[],"photo":[],"content":{"html":"

\n\n

Previously, when building Fava, I used a timed task to pull ¹; previously, the articles on this site were modified and updated manually ^Note1. Here's an example of how to do it with Ubuntu and Forgejo^Note2.

Webhook

Webhook is a webhook utility written with Go that can be used to build a general-purpose webhook server (much like Weibo(微博), with product features as product names). It can be installed directly on Ubuntu:

apt install webhook\nsystemctl enable webhook\ntouch /etc/webhook.yaml\n

Don't start it yet, because the default Webhook service file points to the configuration file /etc/webhook.conf, which neither exists nor has a file extension supported by Webhook. Modify the configuration file /usr/lib/systemd/system/webhook.service:

/usr/lib/systemd/system/webhook.service[Unit]\nDescription=Small server for creating HTTP endpoints (hooks)\nDocumentation=https://github.com/adnanh/webhook/\nConditionPathExists=/etc/webhook.yaml\n\n[Service]\nExecStart=/usr/bin/webhook -nopanic -hotreload -verbose -hooks /etc/webhook.yaml \n\n[Install]\nWantedBy=multi-user.target\n

Webhook also supports configuration files in json format, which has a .json suffix. To continue with the .yaml format, edit /etc/webhook.yaml^Note3:

/etc/webhook.yaml- id: hookname\n  execute-command: \"/path-to-script.sh\"\n  command-working-directory: \"/path-to-working-dir\"\n  pass-arguments-to-command:\n  - source: payload\n    name: head_commit.id\n  - source: payload\n    name: pusher.name\n  - source: payload\n    name: pusher.email\n  trigger-rule:\n    and:\n    - match:\n        type: payload-hmac-sha256\n        secret: 'REPLACE_WITH_YOUR_SECRET'\n        parameter:\n          source: header\n          name: X-Gitea-Signature\n    - match:\n        type: value\n        value: refs/heads/main\n        parameter:\n          source: payload\n          name: ref\n

Note that you need to set the secret, and the name of the master branch (main/master) yourself.

touch /path-to-script.sh\nsystemctl daemon-reload\nsystemctl start webhook\nsystemctl status webhook\n

If the Webhook service can be started normally then continue.

Nginx Proxy

Webhook provides http service on port 9000 by default. For security reasons, Nginx is used as a reverse proxy to provide https service. For more information, please refer to the following:

server {\n    listen          443 ssl http2;\n    listen          [::]:443 ssl http2;\n    server_name your-domain.com;\n\n    # YOUR SSL CONFIG\n\n    location ^~ / {\n        proxy_redirect off;\n        proxy_set_header Host $host;\n        proxy_set_header X-Real-IP $remote_addr;\n        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;\n        proxy_http_version 1.1;\n        proxy_set_header Upgrade $http_upgrade;\n        proxy_set_header Connection \"upgrade\";\n        proxy_pass http://localhost:9000/;\n    }\n    access_log off;\n}\n

Forgejo Adding Hooks

On the settings page of the corresponding repo on Forgejo, add a web hook. The URL should be https://your-domain.com/hooks/hookname and the key text should be REPLACE_WITH_YOUR_SECRET. Save it and click \"Test Push\" at the bottom of the page to debug it.

You should also add a deployment key, which will be the SSH public key that will be used to automate the git pull. If you also need to push code in this environment, remember to check the \"Enable write access\" box.

git pull script

文件 path-to-script.sh：

#!/bin/sh\n\ngit pull\n\nstatus_log=$(git status -sb)\n\n# In bash, `=` in the following line should be `==`\nif [ \"$status_log\" = \"## main...origin/main\" ];then\n        echo \"nothing\"\nelse\n        echo \"commit...\"\n        # git config --global user.email <>\n        git add .\n        git commit -m \"update\" -a\nfi\n\ngit push\n

It is recommended to commit this script to the root of the repo to make it easier to use. After cloning the repo at the target location, try executing the script first:

chomod +x path-to-script.sh\nsh path-to-script.sh\n

Conclusion

At this point, the code is automatically pulled (no Actions at all!). In practice, you may want to refine the webhook's match rules and check parameters in the script as needed.

Notes

\n
Since May, this site has been built using a program based on SvelteKit's own development. ↩
\n
\n
Forgejo is a branch of Gitea, build tutorial: Build Forgejo on Ubuntu. ↩
\n
\n
The Webhook project's example and issue#280 may only work with older versions of Gitea. ↩
\n

References

\n
Dallas Lu. 搭建多用户、多账本 Fava 服务器(Build Multi-User, Multi-Book Fava Server). ↩
\n

\n","headings":[{"level":2,"text":"Webhook","id":"webhook"},{"level":2,"text":"Nginx Proxy","id":"nginx-proxy"},{"level":2,"text":"Forgejo Adding Hooks","id":"forgejo-adding-hooks"},{"level":2,"text":"git pull script","id":"git-pull-script"},{"level":2,"text":"Conclusion","id":"conclusion"}],"meta":{"prism":true},"links":[{"href":"https://github.com/adnanh/webhook","type":"mention"},{"href":"https://github.com/adnanh/webhook/blob/master/docs/Hook-Examples.md#incoming-gitea-webhook","type":"mention"},{"href":"https://github.com/adnanh/webhook/issues/280","type":"mention"}]},"newer":"/eu-org-domain-register-usage/","earlier":"/iproyal-usa-static-residential-proxies/"},{"template":"item","lang":"en","langs":["en","zh-CN"],"summary":{"raw":"Gitea is forked from Gogs. It is said that Gogs developers don't accept extermal PR, so they turn to Gitea, and Forgejo is forked from Gitea, which is a community version of Gitea after Gitea was commercialized.","html":"

Gitea is forked from Gogs. It is said that Gogs developers don't accept extermal PR, so they turn to Gitea, and Forgejo is forked from Gitea, which is a community version of Gitea after Gitea was commercialized.

\n"},"visible":true,"routable":true,"title":"Install Forgejo on Ubuntu","comment":{"enabled":true,"reply":true},"discuss":{"enabled":true},"keywords":["self-hosted Git","Install Gitea","self-hosted Github","private Github","reverse proxy"],"webmention":{"enabled":true,"accept":true,"callback":{"secret":{"hash":{"sha256":"44bb9da44b424c6dfc9233819e907029ff2ccdfaa89919d3696ddf8db7ff6647"}}}},"pingback":{"enabled":true,"accept":true},"slug":"install-forgejo-on-ubuntu","taxonomy":{"category":["Internet"],"tag":["Git","Ubuntu","Forgejo","Gitea","Nginx","Self-hosted"],"series":[]},"route":"/install-forgejo-on-ubuntu/","toc":{"enabled":true},"published":{"date":"2022-12-27 12:27"},"modified":{"date":"2024-06-28T14:30:30.902Z"},"data":{},"license":"WTFPL","author":[{"email":{"value":{"encrypted":"ODgyZjdiZDg4OTVmMjllOGZkNmFmYg==","algorithm":"aes-256-gcm","iv":"067f6d66f2ba5dd50c8443be"},"hash":{"md5":"8770854a9222b6bf1ee195220793bcf1"}},"url":"https://dallas.lu","name":"Dallas Lu","lang":"en","user":"dallaslu"}],"contributor":[],"sponsor":[],"image":[],"audio":[],"video":[],"photo":[],"content":{"html":"

\n\n

Add dedicated user

# Ubuntu\nsudo adduser --system --group --disabled-password --shell /bin/bash --home /home/git --gecos 'Git Version Control' git\n

Prepare folders

sudo mkdir -p /var/lib/forgejo/{custom,data,indexers,public,log}\nsudo chown git:git /var/lib/forgejo/{data,indexers,log}\nsudo chmod 750 /var/lib/forgejo/{data,indexers,log}\nsudo mkdir /etc/forgejo\nsudo chown root:git /etc/forgejo\nsudo chmod 770 /etc/forgejo\n

Download installation file

According to the introduction of forgejo's download page ¹, download the installation file:

wget https://codeberg.org/forgejo/forgejo/releases/download/v1.19.3-0/forgejo-1.19.3-0-linux-amd64\nchmod +x forgejo-1.19.3-0-linux-amd64\n

Verify the signature

gpg --keyserver keys.openpgp.org --recv EB114F5E6C0DC2BCDD183550A4B61A2DC5923710\nwget https://codeberg.org/forgejo/forgejo/releases/download/v1.19.3-0/forgejo-1.19.3-0-linux-amd64.asc\ngpg --verify forgejo-1.19.3-0-linux-amd64.asc forgejo-1.19.3-0-linux-amd64\n

Move to local folder

sudo mv forgejo-1.19.3-0-linux-amd64 /usr/local/bin/forgejo\n

Install dependencies

Git

apt install git\n

Mariadb

apt install mariadb-server\nmysql_secure_installation\nmysql -u root -p\n

CREATE DATABASE forgejo;\nCREATE USER 'forgejo'@'localhost' IDENTIFIED BY '<YOUR_PASSWORD>';\nGRANT ALL ON forgejo.* TO 'forgejo'@'localhost';\nFLUSH PRIVILEGES;\nEXIT;\n

Install as service

vim /usr/lib/systemd/system/forgejo.service\n

[Unit]\nDescription=Forgejo\nAfter=network.target\nAfter=mariadb.service\n\n[Service]\n# Modify these two values and uncomment them if you have\n# repos with lots of files and get an HTTP error 500 because\n# of that\n###\n#LimitMEMLOCK=infinity\n#LimitNOFILE=65535\nRestartSec=2s\nType=simple\nUser=git\nGroup=git\nWorkingDirectory=/var/lib/forgejo/\nExecStart=/usr/local/bin/forgejo web -c /etc/forgejo/app.ini\nRestart=always\nEnvironment=USER=git HOME=/home/git GITEA_WORK_DIR=/var/lib/forgejo\n# If you want to bind to a port below 1024 uncomment\n# the two values below\n###\n#CapabilityBoundingSet=CAP_NET_BIND_SERVICE\n#AmbientCapabilities=CAP_NET_BIND_SERVICE\n\n[Install]\nWantedBy=multi-user.target\n

sudo systemctl daemon-reload\nsudo systemctl enable --now forgejo\n\nsudo firewall-cmd --add-port 3000/tcp --permanent\nsudo firewall-cmd --reload \n

Nginx Configuration

You can configure an SSL host with the domain name git.example.com and add reverse proxy config：

location ^~ / {\n        proxy_redirect off;\n        proxy_set_header X-Forwarded-Proto https;\n        proxy_set_header Host $host;\n        proxy_set_header X-Real-IP $remote_addr;\n        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;\n\n        if (!-e $request_filename) {\n                proxy_pass http://127.0.0.1:3000;\n                break;\n        }\n}\n

Installation Guide

Visit https://git.example.com/install, follow the wizard to complete the installation process.

Adjust Forgejo configuration

vim /etc/forgejo/app.ini\n

(Reference: app.example.ini)

Just restart Forgejo after modifying the configuration.

References

\n
https://forgejo.org/download/ ↩
\n

\n","headings":[{"level":2,"text":"Add dedicated user","id":"add-dedicated-user"},{"level":2,"text":"Prepare folders","id":"prepare-folders"},{"level":2,"text":"Download installation file","id":"download-installation-file"},{"level":3,"text":"Verify the signature","id":"verify-the-signature"},{"level":3,"text":"Move to local folder","id":"move-to-local-folder"},{"level":2,"text":"Install dependencies","id":"install-dependencies"},{"level":3,"text":"Git","id":"git"},{"level":3,"text":"Mariadb","id":"mariadb"},{"level":2,"text":"Install as service","id":"install-as-service"},{"level":2,"text":"Nginx Configuration","id":"nginx-configuration"},{"level":2,"text":"Installation Guide","id":"installation-guide"},{"level":2,"text":"Adjust Forgejo configuration","id":"adjust-forgejo-configuration"}],"meta":{"prism":true},"links":[{"href":"https://codeberg.org/forgejo/forgejo/src/branch/forgejo/custom/conf/app.example.ini","type":"mention"},{"href":"https://forgejo.org/download/","type":"mention"}]},"newer":"/something-about-nostr-protocol/","earlier":"/apache-subversion-behind-nginx/"}]

Tag: Forgejo

Using Webhook to Automatically Pull Code

2023

Install Forgejo on Ubuntu

2022