[{"template":"item","lang":"zh-CN","langs":["en","zh-CN"],"summary":{"raw":"很多应用以文本来存储数据，比如 Beancount 账本、一些静态博客。这些数据非常适合用 git 来做版本管理。但本地修改并 push 之后，还需要在其他地方 pull 才行。本文使用 Webhook 来自动完成这一操作过程。","html":"

很多应用以文本来存储数据，比如 Beancount 账本、一些静态博客。这些数据非常适合用 git 来做版本管理。但本地修改并 push 之后，还需要在其他地方 pull 才行。本文使用 Webhook 来自动完成这一操作过程。

\n"},"visible":true,"routable":true,"title":"使用 Webhook 来自动拉取代码","comment":{"enabled":true,"reply":true},"discuss":{"enabled":true},"keywords":["Webhook 入门","Webhook 使用","自动pull代码","Webhook 配置","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":"达拉斯・卢","lang":"zh-CN","user":"dallaslu"}],"contributor":[],"sponsor":[],"image":[],"audio":[],"video":[],"photo":[],"content":{"html":"

\n\n

之前在搭建 Fava 时，使用了定时任务来 pull¹；此前本站的文章修改后也是手动更新的^注1。下面以 Ubuntu 系统和 Forgejo 为例进行操作^注2。

Webhook

Webhook 是一个 Go 语言的 webhook 工具，可以用来搭建通用的 webhook server（跟微博一样，用产品功能当产品名）。在 Ubuntu 上可以直接安装：

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

先不要着急启动，因为默认的 Webhook 的 service 文件中把配置文件指向了 /etc/webhook.conf，这个文件既不存在，其文件后缀也不能被 Webhook 所支持。修改配置文件 /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 也支持 json 格式的配置文件，对应的配置文件名后缀是 .json。下面以 .yaml 格式继续操作，编辑 /etc/webhook.yaml^注3：

/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

这里要注意，需要自己设定 secret，以及主分支名称（main/master）。

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

如果 Webhook 服务可以正常启动再继续。

Nginx 代理

Webhook 默认在本机的 9000 端口提供 http 服务，安全起见，用 Nginx 做反代来提供 https 服务。可参考：

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 添加钩子

在 Forgejo 上对应 repo 的设置页面，添加一个 Web钩子。其中，URL 应该填写为 https://your-domain.com/hooks/hookname，密钥文本应该填写为 REPLACE_WITH_YOUR_SECRET。保存后可在页面下方点击「测试推送」来调试。

还要添加一个部署密钥，将需要自动 git pull 所使用 SSH 公钥填上。如果同时需要在这个环境 push 代码，记得勾选「启用写权限」。

git pull 脚本

文件 path-to-script.sh：

#!/bin/sh\n\ngit pull\n\nstatus_log=$(git status -sb)\n\n# 在 bash 中，下面一行中的 `=` 应为 `==`\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

建议将这个脚本提交到 repo 的根目录下，这样使用起来更方便。在目标位置 clone 好 repo 后，先试执行脚本：

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

结语

至此，就实现了自动 pull 代码（要啥 Actions!）。实际使用上，根据需要，可能要细化 webhook 的 match 规则，以及在脚本中检查参数。

注释

\n
从5月份开始，本站使用基于 SvelteKit 自行开发的程序搭建。 ↩
\n
\n
Forgejo 是 Gitea 的一个分支，搭建教程：在 Ubuntu 上搭建 Forgejo。 ↩
\n
\n
Webhook 项目的示例和 issue#280 的配置方式可能只适用于旧版本的 Gitea. ↩
\n

参考

\n
搭建多用户、多账本 Fava 服务器 ↩
\n

\n","headings":[{"level":2,"text":"Webhook","id":"webhook"},{"level":2,"text":"Nginx 代理","id":"nginx-代理"},{"level":2,"text":"Forgejo 添加钩子","id":"forgejo-添加钩子"},{"level":2,"text":"git pull 脚本","id":"git-pull-脚本"},{"level":2,"text":"结语","id":"结语"}],"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":"/why-do-miit-fuck-apps/","earlier":"/ufw-route-as-a-wonderful-usage-of-gfw-blocked-ip/"},{"template":"item","lang":"zh-CN","langs":["en","zh-CN"],"summary":{"raw":"Gitea 是 Gogs 的分支，据说 Gogs 的开发者不接受外部 PR，于是大家纷纷转向 Gitea。而 Forgejo 是 fork 自 Gitea，是 Gitea 商业化后出现的社区版。","html":"

Gitea 是 Gogs 的分支，据说 Gogs 的开发者不接受外部 PR，于是大家纷纷转向 Gitea。而 Forgejo 是 fork 自 Gitea，是 Gitea 商业化后出现的社区版。

\n"},"visible":true,"routable":true,"title":"在 Ubuntu 上搭建 Forgejo","comment":{"enabled":true,"reply":true},"discuss":{"enabled":true},"keywords":["自建 Git 托管","搭建 Gitea","安装 Gitea","自建 Github","私有 Github"],"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":"达拉斯・卢","lang":"zh-CN","user":"dallaslu"}],"contributor":[],"sponsor":[],"image":[],"audio":[],"video":[],"photo":[],"content":{"html":"

Gitea 是 Gogs 的分支，据说 Gogs 的开发者不接受外部 PR，于是大家纷纷转向 Gitea。而 Forgejo 是 fork 自 Gitea，是 Gitea 商业化后出现的社区版。

\n\n

添加专用用户

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

准备目录

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

下载安装文件

根据 forgejo 的下载页面¹的介绍，下载安装文件：

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

验证签名

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

移动到本地目录

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

安装依赖

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

安装为服务

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 配置

可配置一个域名为 git.example.com 的 ssl 主机，并添加反代：

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

安装向导

访问 https://git.example.com/install，根据向导完成安装过程。

调整 Forgejo 配置

vim /etc/forgejo/app.ini\n

参考： app.example.ini

修改配置后重启 forgejo 即可。

参考

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

\n","headings":[{"level":2,"text":"添加专用用户","id":"添加专用用户"},{"level":2,"text":"准备目录","id":"准备目录"},{"level":2,"text":"下载安装文件","id":"下载安装文件"},{"level":3,"text":"验证签名","id":"验证签名"},{"level":3,"text":"移动到本地目录","id":"移动到本地目录"},{"level":2,"text":"安装依赖","id":"安装依赖"},{"level":3,"text":"Git","id":"git"},{"level":3,"text":"Mariadb","id":"mariadb"},{"level":2,"text":"安装为服务","id":"安装为服务"},{"level":2,"text":"Nginx 配置","id":"nginx-配置"},{"level":2,"text":"安装向导","id":"安装向导"},{"level":2,"text":"调整 Forgejo 配置","id":"调整-forgejo-配置"}],"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":"/ubuntu-fava-server-for-multiple-user/","earlier":"/solve-interesting-business-puzzles-with-beancount/"}]

标签: Forgejo

使用 Webhook 来自动拉取代码

2023

在 Ubuntu 上搭建 Forgejo

2022