hosting/mash-playbook
1
0
Fork 0
Code Pull requests Activity

Merge pull request #162 from sergiodj/improve-woodpecker-agent-doc

Browse source 
Improve Woodpecker's main docs re. agent secrets
This commit is contained in:
Slavi Pantaleev 2024-03-11 08:30:29 +02:00 committed by GitHub
commit e21dca756e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 16 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
docs/services/woodpecker-ci.md
View file

@ -40,6 +40,13 @@ devture_woodpecker_ci_server_hostname: mash.example.com
devture_woodpecker_ci_server_path_prefix: /ci
# Generate this secret with `openssl rand -hex 32`
#
# Note that this playbook only supports agent-specific secrets, which
# means that if you choose to share this secret with an agent, the
# server will register it as a non-persistent agent.
#
# See the definition of
# devture_woodpecker_ci_agent_config_agent_secret below for more details.
devture_woodpecker_ci_server_config_agent_secret: ''
devture_woodpecker_ci_server_config_admins: [YOUR_USERNAME_HERE]
@ -126,9 +133,15 @@ devture_woodpecker_ci_agent_enabled: true
# gRPC port will likely be 443. E.g., ci.example.com:443.
devture_woodpecker_ci_agent_config_server: ''
# Enter your server's secret below.
# This value must match the `devture_woodpecker_ci_server_config_agent_secret` variable.
devture_woodpecker_ci_agent_config_agent_secret: ''
# This playbook only supports agent-specific secrets, i.e., it is not recommended to use
# a shared secret between Woodpecker CI Server and all of its agents. Please refer to
# the following upstream documentation in order to learn how to register an agent and
# obtain a secret for it:
#
# https://woodpecker-ci.org/docs/administration/agent-config#using-agent-token
#
# then, when you have the agent secret, uncomment the following line.
#devture_woodpecker_ci_agent_config_agent_secret: ''
# Uncomment the line below if you want the agent to connect to the
# server over a secure gRPC channel (recommended).