diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 6384007..ae50387 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -42,23 +42,23 @@ export default defineConfig({ collapsed: true, // 默认展开 // link: 'https://docs.gitea.com/zh-cn/category/installation', items: [ - { text: '对比Gitea与其它Git托管工具', link: '/document/installation/comparison.md' }, - { text: '数据库准备', link: '/document/installation/database-preparation.md' }, - { text: '使用二进制文件安装', link: '/document/installation/from-binary.md' }, - { text: '包管理器安装', link: '/document/installation/from-package.md' }, - { text: '使用源代码安装', link: '/document/installation/from-source.md' }, - { text: '在Linux中以service方式运行', link: '/document/installation/run-as-service-in-ubuntu.md' },// - { text: '注册为Windows服务', link: '/document/installation/windows-service.md' }, - { text: '使用Docker安装(rootless)', link: '/document/installation/with-docker-rootless.md' }, - { text: '使用Docker安装', link: '/document/installation/with-docker.md' }, - { text: '在Kubernetes中安装Gitea', link: '/document/installation/on-kubernetes.md' }, - { text: '在云服务器上安装Gitea', link: '/document/installation/on-cloud-provider.md' }, - { text: '从旧版Gitea升级', link: '/document/installation/upgrade-from-gitea.md' }, + { text: '对比Gitea与其它Git托管工具', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, + { text: '数据库准备', link: 'https://docs.gitea.com/zh-cn/installation/database-prep' }, + { text: '使用二进制文件安装', link: 'https://docs.gitea.com/zh-cn/installation/install-from-binary' }, + { text: '包管理器安装', link: 'https://docs.gitea.com/zh-cn/installation/install-from-package' }, + { text: '使用源代码安装', link: 'https://docs.gitea.com/zh-cn/installation/install-from-source' }, + { text: '在Linux中以service方式运行', link: 'https://docs.gitea.com/zh-cn/installation/linux-service' },// + { text: '注册为Windows服务', link: 'https://docs.gitea.com/zh-cn/installation/windows-service' }, + { text: '使用Docker安装(rootless)', link: 'https://docs.gitea.com/zh-cn/installation/install-with-docker-rootless' }, + { text: '使用Docker安装', link: 'https://docs.gitea.com/zh-cn/installation/install-with-docker' }, + { text: '在Kubernetes中安装Gitea', link: 'https://docs.gitea.com/zh-cn/installation/install-on-kubernetes' }, + { text: '在云服务器上安装Gitea', link: 'https://docs.gitea.com/zh-cn/installation/install-on-cloud-provider' }, + { text: '从旧版Gitea升级', link: 'https://docs.gitea.com/zh-cn/installation/upgrade-from-gitea' }, ] } as any, { text: '管理', - link: 'https://docs.gitea.com/zh-cn/category/administration', + // link: 'https://docs.gitea.com/zh-cn/category/administration', collapsible: true, // 使整个组可折叠 collapsed: true, // 默认展开 items: [ @@ -85,7 +85,7 @@ export default defineConfig({ } as any, { text: '使用', - link: 'https://docs.gitea.com/zh-cn/category/usage', + // link: 'https://docs.gitea.com/zh-cn/category/usage', collapsible: true, // 使整个组可折叠 collapsed: true, // 默认展开 items: [ @@ -94,15 +94,15 @@ export default defineConfig({ collapsible: true, // 使整个组可折叠 collapsed: false, // 默认展开 items: [ - { text: 'Overview', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: '快速入门', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: '与GitHub Actions的对比', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'Act Runner', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: '变量', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'Gitea Actions设计', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: '密钥管理', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'Gitea Actions常见问题解答', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'Badge', link: 'https://docs.gitea.com/zh-cn/installation/comparison' } + { text: 'Overview', link: 'https://docs.gitea.com/zh-cn/usage/actions/overview' }, + { text: '快速入门', link: 'https://docs.gitea.com/zh-cn/usage/actions/quickstart' }, + { text: '与GitHub Actions的对比', link: 'https://docs.gitea.com/zh-cn/usage/actions/comparison' }, + { text: 'Act Runner', link: 'https://docs.gitea.com/zh-cn/usage/actions/act-runner' }, + { text: '变量', link: 'https://docs.gitea.com/zh-cn/usage/actions/actions-variables' }, + { text: 'Gitea Actions设计', link: 'https://docs.gitea.com/zh-cn/usage/actions/design' }, + { text: '密钥管理', link: 'https://docs.gitea.com/zh-cn/usage/actions/secrets' }, + { text: 'Gitea Actions常见问题解答', link: 'https://docs.gitea.com/zh-cn/usage/actions/faq' }, + { text: 'Badge', link: 'https://docs.gitea.com/zh-cn/usage/actions/badge' } ] }, { @@ -110,78 +110,78 @@ export default defineConfig({ collapsible: true, // 使整个组可折叠 collapsed: true, // 默认展开 items: [ - { text: '软件包注册表', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'Alpine 软件包注册表', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'Arch package registry', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'Cargo 软件包注册表', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'Chef 软件包注册表', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: '存储', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'Composer 软件包注册表', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'Conan 软件包注册表', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'Conda 软件包注册表', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: '容器注册表', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'CRAN 软件包注册表', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'Go 软件包注册表', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'Helm Chart 注册表', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'Maven 软件包注册表', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'NPM Package Registry', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'NuGet 软件包注册表', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'Pub 软件包注册表', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'PyPI 软件包注册表', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'RPM 软件包注册表', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'RubyGems 软件包注册表', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'Swift 软件包注册表', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'Vagrant 软件包注册表', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: '通用软件包注册表', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'Debian 软件包注册表', link: 'https://docs.gitea.com/zh-cn/installation/comparison' } + { text: '软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/overview' }, + { text: 'Alpine 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/alpine' }, + { text: 'Arch package registry', link: 'https://docs.gitea.com/zh-cn/usage/packages/arch' }, + { text: 'Cargo 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/cargo' }, + { text: 'Chef 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/chef' }, + { text: '存储', link: 'https://docs.gitea.com/zh-cn/usage/packages/storage' }, + { text: 'Composer 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/composer' }, + { text: 'Conan 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/conan' }, + { text: 'Conda 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/conda' }, + { text: '容器注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/container' }, + { text: 'CRAN 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/cran' }, + { text: 'Go 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/go' }, + { text: 'Helm Chart 注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/helm' }, + { text: 'Maven 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/maven' }, + { text: 'NPM Package Registry', link: 'https://docs.gitea.com/zh-cn/usage/packages/npm' }, + { text: 'NuGet 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/nuget' }, + { text: 'Pub 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/pub' }, + { text: 'PyPI 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/pypi' }, + { text: 'RPM 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/packages/rpm' }, + { text: 'RubyGems 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/rubygems' }, + { text: 'Swift 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/swift' }, + { text: 'Vagrant 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/vagrant' }, + { text: '通用软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/generic' }, + { text: 'Debian 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/debian' } ] }, - { text: 'AGit', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: '个人资料 README', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'Blame File View', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: '邮件接收', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: '标签', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: '合并请求', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: '权限', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: '模板仓库', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: '从模板创建工单与合并请求', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: '自动链接引用', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: '合并消息模板', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: '推送', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'Blocking a user', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: '克隆过滤器 (部分克隆)', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'Code Owners', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'Webhooks', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'Migration', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: '受保护的标签', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: '仓库镜像', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'Markdown', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'Multi-factor Authentication (MFA)', link: 'https://docs.gitea.com/zh-cn/installation/comparison' } + { text: 'AGit', link: 'https://docs.gitea.com/zh-cn/usage/agit' }, + { text: '个人资料 README', link: 'https://docs.gitea.com/zh-cn/usage/profile-readme' }, + { text: 'Blame File View', link: 'https://docs.gitea.com/zh-cn/usage/blame' }, + { text: '邮件接收', link: 'https://docs.gitea.com/zh-cn/usage/incoming-email' }, + { text: '标签', link: 'https://docs.gitea.com/zh-cn/usage/labels' }, + { text: '合并请求', link: 'https://docs.gitea.com/zh-cn/usage/pull-request' }, + { text: '权限', link: 'https://docs.gitea.com/zh-cn/usage/permissions' }, + { text: '模板仓库', link: 'https://docs.gitea.com/zh-cn/usage/template-repositories' }, + { text: '从模板创建工单与合并请求', link: 'https://docs.gitea.com/zh-cn/usage/issue-pull-request-templates' }, + { text: '自动链接引用', link: 'https://docs.gitea.com/zh-cn/usage/automatically-linked-references' }, + { text: '合并消息模板', link: 'https://docs.gitea.com/zh-cn/usage/merge-message-template' }, + { text: '推送', link: 'https://docs.gitea.com/zh-cn/usage/push' }, + { text: 'Blocking a user', link: 'https://docs.gitea.com/zh-cn/usage/blocking-user' }, + { text: '克隆过滤器 (部分克隆)', link: 'https://docs.gitea.com/zh-cn/usage/clone-filters' }, + { text: 'Code Owners', link: 'https://docs.gitea.com/zh-cn/usage/code-owners' }, + { text: 'Webhooks', link: 'https://docs.gitea.com/zh-cn/usage/webhooks' }, + { text: 'Migration', link: 'https://docs.gitea.com/zh-cn/usage/migration' }, + { text: '受保护的标签', link: 'https://docs.gitea.com/zh-cn/usage/protected-tags' }, + { text: '仓库镜像', link: 'https://docs.gitea.com/zh-cn/usage/repo-mirror' }, + { text: 'Markdown', link: 'https://docs.gitea.com/zh-cn/usage/markdown' }, + { text: 'Multi-factor Authentication (MFA)', link: 'https://docs.gitea.com/zh-cn/usage/multi-factor-authentication' } ] } as any, { text: '开发', - link: 'https://docs.gitea.com/zh-cn/category/development', + // link: 'https://docs.gitea.com/zh-cn/category/development', collapsible: true, // 使整个组可折叠 collapsed: true, // 默认展开 items: [ - { text: '玩转 Gitea', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'API 使用指南', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: 'OAuth2 提供者', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: '迁移接口', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: '集成', link: 'https://docs.gitea.com/zh-cn/installation/comparison' } + { text: '玩转 Gitea', link: 'https://docs.gitea.com/zh-cn/development/hacking-on-gitea' }, + { text: 'API 使用指南', link: 'https://docs.gitea.com/zh-cn/development/api-usage' }, + { text: 'OAuth2 提供者', link: 'https://docs.gitea.com/zh-cn/development/oauth2-provider' }, + { text: '迁移接口', link: 'https://docs.gitea.com/zh-cn/development/migrations-interfaces' }, + { text: '集成', link: 'https://docs.gitea.com/zh-cn/development/integrations' } ] } as any, { - text: '贡献', - link: 'https://docs.gitea.com/zh-cn/category/contributing', + // text: '贡献', + // link: 'https://docs.gitea.com/zh-cn/category/contributing', collapsible: true, // 使整个组可折叠 collapsed: true, // 默认展开 items: [ - { text: '后端开发指南', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: '前端开发指南', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: '重构指南', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: '本地化', link: 'https://docs.gitea.com/zh-cn/installation/comparison' } + { text: '后端开发指南', link: 'https://docs.gitea.com/zh-cn/contributing/guidelines-backend' }, + { text: '前端开发指南', link: 'https://docs.gitea.com/zh-cn/contributing/guidelines-frontend' }, + { text: '重构指南', link: 'https://docs.gitea.com/zh-cn/contributing/guidelines-refactoring' }, + { text: '本地化', link: 'https://docs.gitea.com/zh-cn/contributing/localization' } ] } as any, { @@ -190,8 +190,8 @@ export default defineConfig({ collapsible: true, // 使整个组可折叠 collapsed: true, // 默认展开 items: [ - { text: '常见问题', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: '支持选项', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, + { text: '常见问题', link: 'https://docs.gitea.com/zh-cn/help/faq' }, + { text: '支持选项', link: 'https://docs.gitea.com/zh-cn/help/support' }, ] } as any, ], diff --git a/docs/public/DevStar.png b/docs/public/DevStar.png new file mode 100644 index 0000000..f98894c Binary files /dev/null and b/docs/public/DevStar.png differ diff --git a/docs/runner/index.md b/docs/runner/index.md new file mode 100644 index 0000000..e9e64b5 --- /dev/null +++ b/docs/runner/index.md @@ -0,0 +1,104 @@ +--- +sidebar_position: 1 +slug: / +--- + +# What is Gitea Runner + +Act runner is a runner for Gitea based on [Gitea fork](https://gitea.com/gitea/act) of [act](https://github.com/nektos/act). This documentation is a copy of https://gitea.com/gitea/act_runner/src/branch/main/README.md . And it should be updated once that README changed. + +## Installation + +### Prerequisites + +Docker Engine Community version is required for docker mode. To install Docker CE, follow the official [install instructions](https://docs.docker.com/engine/install/). + +### Download pre-built binary + +Visit [here](https://dl.gitea.com/act_runner/) and download the right version for your platform. + +### Build from source + +```bash +make build +``` + +### Build a docker image + +```bash +make docker +``` + +### Register + +```bash +./act_runner register +``` + +And you will be asked to input: + +1. Gitea instance URL, like `http://192.168.8.8:3000/`. You should use your gitea instance ROOT_URL as the instance argument + and you should not use `localhost` or `127.0.0.1` as instance IP; +2. Runner token, you can get it from `http://192.168.8.8:3000/-/admin/actions/runners`; +3. Runner name, you can just leave it blank; +4. Runner labels, you can just leave it blank. + +The process looks like: + +```text +INFO Registering runner, arch=amd64, os=darwin, version=0.1.5. +WARN Runner in user-mode. +INFO Enter the Gitea instance URL (for example, https://gitea.com/): +http://192.168.8.8:3000/ +INFO Enter the runner token: +fe884e8027dc292970d4e0303fe82b14xxxxxxxx +INFO Enter the runner name (if set empty, use hostname: Test.local): + +INFO Enter the runner labels, leave blank to use the default labels (comma-separated, for example, ubuntu-latest:docker://gitea/runner-images:ubuntu-latest): + +INFO Registering runner, name=Test.local, instance=http://192.168.8.8:3000/, labels=[ubuntu-latest:docker://gitea/runner-images:ubuntu-latest ubuntu-22.04:docker://gitea/runner-images:ubuntu-22.04 ubuntu-20.04:docker://gitea/runner-images:ubuntu-20.04]. +DEBU Successfully pinged the Gitea instance server +INFO Runner registered successfully. +``` + +You can also register with command line arguments. + +```bash +./act_runner register --instance http://192.168.8.8:3000 --token --no-interactive +``` + +If the registry succeed, it will run immediately. Next time, you could run the runner directly. + +### Run + +```bash +./act_runner daemon +``` + +### Run with docker + +```bash +docker run -e GITEA_INSTANCE_URL=https://your_gitea.com -e GITEA_RUNNER_REGISTRATION_TOKEN= -v /var/run/docker.sock:/var/run/docker.sock --name my_runner gitea/act_runner:nightly +``` + +### Configuration + +You can also configure the runner with a configuration file. +The configuration file is a YAML file, you can generate a sample configuration file with `./act_runner generate-config`. + +```bash +./act_runner generate-config > config.yaml +``` + +You can specify the configuration file path with `-c`/`--config` argument. + +```bash +./act_runner -c config.yaml register # register with config file +./act_runner -c config.yaml daemon # run with config file +``` + +You can read the latest version of the configuration file online at [config.example.yaml](internal/pkg/config/config.example.yaml). + +### Example Deployments + +Check out the [examples](https://gitea.com/gitea/act_runner/src/branch/main/examples) directory for sample deployment types.