docs: Install with galaxy and use docsmith
Signed-off-by: Julien Riou <julien@riou.xyz>
This commit is contained in:
parent
0fc90b71ef
commit
fe492d6188
5 changed files with 485 additions and 13 deletions
106
meta/argument_specs.yml
Normal file
106
meta/argument_specs.yml
Normal file
|
|
@ -0,0 +1,106 @@
|
|||
---
|
||||
argument_specs:
|
||||
main:
|
||||
short_description: Install and configure a Forgejo instance
|
||||
description:
|
||||
- Install and configure a [Forgejo](https://forgejo.org/) instance.
|
||||
author:
|
||||
- jriou
|
||||
options:
|
||||
forgejo_server:
|
||||
description:
|
||||
- Enable the server mode
|
||||
type: bool
|
||||
default: true
|
||||
|
||||
forgejo_version:
|
||||
description:
|
||||
- Version of the Forgejo binaries
|
||||
type: int
|
||||
default: 13
|
||||
|
||||
forgejo_home_dir:
|
||||
description:
|
||||
- Path to the home directory
|
||||
type: path
|
||||
default: /var/lib/forgejo
|
||||
|
||||
forgejo_config_dir:
|
||||
description:
|
||||
- Path to the configuration directory
|
||||
type: path
|
||||
default: /etc/forgejo
|
||||
|
||||
forgejo_web_port:
|
||||
description:
|
||||
- Port to listen for the web UI
|
||||
type: int
|
||||
default: 3000
|
||||
|
||||
forgejo_ssh_port:
|
||||
description:
|
||||
- Port to listen for SSH
|
||||
type: int
|
||||
default: 222
|
||||
|
||||
forgejo_db_username:
|
||||
description:
|
||||
- Name of the user in the database
|
||||
default: forgejo
|
||||
|
||||
forgejo_db_password:
|
||||
description:
|
||||
- Password of the user in the database
|
||||
required: true
|
||||
|
||||
forgejo_db_database:
|
||||
description:
|
||||
- Name of the database
|
||||
default: forgejo
|
||||
|
||||
forgejo_mailer:
|
||||
description:
|
||||
- Configure the mailer to send e-mail notifications
|
||||
- Define a `enabled` key with a boolean to enable the mailer
|
||||
- Define a `from` key with the source e-mail address
|
||||
- See [Email setup](https://forgejo.org/docs/latest/admin/setup/email/)
|
||||
type: dict
|
||||
|
||||
forgejo_service:
|
||||
description:
|
||||
- Configure service settings
|
||||
- See [Service](https://forgejo.org/docs/latest/admin/config-cheat-sheet/#service-service)
|
||||
type: dict
|
||||
|
||||
forgejo_manage_iptables:
|
||||
description:
|
||||
- Configure iptables rules
|
||||
type: bool
|
||||
default: false
|
||||
|
||||
forgejo_allowed_sources:
|
||||
description:
|
||||
- List of IP ranges to allow when `forgejo_manage_iptables` is enabled
|
||||
type: list
|
||||
|
||||
forgejo_runners_version:
|
||||
description:
|
||||
- Version of the runners
|
||||
default: 9.1.1
|
||||
|
||||
forgejo_runners_config_dir:
|
||||
description:
|
||||
- Path to the configuration directory of the runners
|
||||
type: path
|
||||
default: /etc/forgejo-runners
|
||||
|
||||
forgejo_runners_instance:
|
||||
description:
|
||||
- URL of the Forgejo instance to register the runners
|
||||
|
||||
forgejo_runners:
|
||||
description:
|
||||
- List of runners to configure
|
||||
- The key is the name of the repository on the instance
|
||||
- The value is the token
|
||||
type: dict
|
||||
Loading…
Add table
Add a link
Reference in a new issue