1
0
Fork 0
mirror of https://github.com/roles-ansible/ansible_role_forgeo_runner.git synced 2024-08-16 10:29:50 +02:00

Merge pull request #1 from roles-ansible/docs

improve Documentation
This commit is contained in:
L3D 2024-03-21 16:45:16 +01:00 committed by GitHub
commit ab0828bde7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 25 additions and 4 deletions

View file

@ -4,9 +4,30 @@
ansible role forgeo_runner ansible role forgeo_runner
======================= =======================
Ansible role to install and Setup forgeo runner. (Work in Progress...) Ansible role to install and Setup forgeo runner.
https://forgejo.org/docs/next/admin/actions/ Visit [code.forgejo.org/forgejo/runner](https://code.forgejo.org/forgejo/runner) for more information about forgejo actions.
Requirements
--------------
Steps This role requires either to be able to start docker containers as ``forgejo_runner`` User or you change the ``forgejo_runner__mode`` variable to run actions directly without containerisation which could break your system.
Variables
-----------
| Variable | Value | Description |
| -------- | ----- | ----------- |
| ``forgejo_runner__version`` | ``latest`` | Forgejo runner version or latest to use latest |
| ``forgejo_runner__user`` | ``forgejo_runner`` | Forejo runner UNIX User |
| ``forgejo_runner__group`` | ``forgejo_runner`` | Forgejo runner UNIX Group |
| ``forgejo_runner__user_home`` | ``/var/lib/forgejo-runner`` | Unix Home and working directory |
| ``forgejo_runner__full_executable_path`` | ``/usr/local/bin/forgejo_runner`` | Path for executable binary |
| ``forgejo_runner__gpg_id`` | ``EB114F5E6C0DC2BCDD183550A4B61A2DC5923710`` | Forgejo runneer GPG Key |
| ``forgejo_runner__instance_address`` | | Forgejo Instance Address |
| ``forgejo_runner__token`` | | Token for runner of your forgejo instance |
| ``forgejo_runner__mode`` | ``daemon`` | Forgejo runner mode. Change to ``exec`` for local Runner execution |
| ``submodules_versioncheck`` | ``false`` | optional simple version check |
Contribution
--------------
Please feel free to open an issue or Pull-Request

View file

@ -12,5 +12,5 @@ forgejo_runner__arch: "{{ forgejo_runner__go_arch_map[ansible_architecture] | de
forgejo_runner__git_repo: 'https://code.forgejo.org/forgejo/runner' forgejo_runner__git_repo: 'https://code.forgejo.org/forgejo/runner'
# versionscheck # versionscheck
playbook_version_number: 03 # should be a integer playbook_version_number: 04 # should be a integer
playbook_version_path: 'role-l3d.git-forgejo_runner.version' playbook_version_path: 'role-l3d.git-forgejo_runner.version'