confdroid/confdroid_gitea
3
0
Fork 0
Code Issues Projects Wiki Activity
Files
882431c2e51bf7c1101dcb6470d843c8300ad8b1
confdroid_gitea/doc/puppet_classes/confdroid_gitea_3A_3Aparams.html

1024 lines
22 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Puppet Class: confdroid_gitea::params
&mdash; Documentation by YARD 0.9.36
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "puppet_classes::confdroid_gitea::params";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../puppet_class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (c)</a> &raquo;
<span class='title'><span class='object_link'>Puppet Classes</span></span>
&raquo;
<span class="title">confdroid_gitea::params</span>
</div>
<div id="search">
<a class="full_list_link" id="puppet_class_list_link"
href="../puppet_class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Puppet Class: confdroid_gitea::params</h1>
<div class="box_info">
<dl>
<dt>Inherited by:</dt>
<dd>
<span class='object_link'><a href="confdroid_gitea_3A_3Amain_3A_3Adirs.html" title="puppet_classes::confdroid_gitea::main::dirs (puppet_class)">confdroid_gitea::main::dirs</a></span><br/>
<span class='object_link'><a href="confdroid_gitea_3A_3Amain_3A_3Auser.html" title="puppet_classes::confdroid_gitea::main::user (puppet_class)">confdroid_gitea::main::user</a></span><br/>
<span class='object_link'><a href="confdroid_gitea_3A_3Amain_3A_3Afiles.html" title="puppet_classes::confdroid_gitea::main::files (puppet_class)">confdroid_gitea::main::files</a></span><br/>
<span class='object_link'><a href="confdroid_gitea_3A_3Amain_3A_3Aconfig.html" title="puppet_classes::confdroid_gitea::main::config (puppet_class)">confdroid_gitea::main::config</a></span><br/>
<span class='object_link'><a href="confdroid_gitea_3A_3Amain_3A_3Ainstall.html" title="puppet_classes::confdroid_gitea::main::install (puppet_class)">confdroid_gitea::main::install</a></span><br/>
<span class='object_link'><a href="confdroid_gitea_3A_3Amain_3A_3Aservice.html" title="puppet_classes::confdroid_gitea::main::service (puppet_class)">confdroid_gitea::main::service</a></span><br/>
<span class='object_link'><a href="confdroid_gitea_3A_3Afirewall_3A_3Aiptables.html" title="puppet_classes::confdroid_gitea::firewall::iptables (puppet_class)">confdroid_gitea::firewall::iptables</a></span><br/>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>
manifests/params.pp
</dd>
</dl>
</div>
<h2>Summary</h2>
holds all parameters for the confdroid_gitea Puppet module.
<h2>Overview</h2>
<div class="docstring">
<div class="discussion">
<p>confdroid_gitea::params.pp Module name: confdroid_gitea Author: 12ww1160 (12ww1160@confdroid.com)</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>ga_use_firewall</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to enable firewall rules for Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_http_port</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;3000&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The main port number for Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_ssh_port</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;22&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The SSH port number for Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_order_prefix</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;50&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The order prefix for firewall rules.</p>
</div>
</li>
<li>
<span class='name'>ga_host_fqdn</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;gitea.example.net&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The FQDN for the Gitea host.</p>
</div>
</li>
<li>
<span class='name'>ga_opt_dir</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/opt/gitea&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The installation directory for Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_dl_url</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;https://dl.gitea.com/gitea&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The download URL for Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_dl_version</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;1.25.4&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The version of Gitea to download.</p>
</div>
</li>
<li>
<span class='name'>ga_user</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;git&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The system user for Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_reqpackages</span>
<span class='type'>(<tt>Array</tt>)</span>
<em class="default">(defaults to: <tt>[&#39;git&#39;, &#39;wget&#39;, &#39;tar&#39;]</tt>)</em>
&mdash;
<div class='inline'>
<p>The required packages for Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_pkg_ensure</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;present&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The ensure state for required packages.</p>
</div>
</li>
<li>
<span class='name'>ga_domain</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;localhost&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The domain for the Gitea host. defaults to ‘localhost’.</p>
</div>
</li>
<li>
<span class='name'>ga_root_url</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;http://localhost:3000&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The root URL for Gitea. defaults to ‘<a href="http://localhost:3000">localhost:3000</a>’.</p>
</div>
</li>
<li>
<span class='name'>ga_disable_ssh</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to disable SSH access in Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_start_lfs</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to start Git LFS support in Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_start_ssh</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to start SSH support in Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_db_type</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;postgres&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The database type for Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_db_host</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;localhost&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The database host for Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_db_port</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;5432&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The database port for Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_db_name</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;gitea&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The database name for Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_db_user</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;ChangeMe&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The database user for Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_db_password</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;ChangeMe&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The database password for Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_log_sql</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to enable SQL query logging in Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_ssl_mode</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;require&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The SSL mode for the database connection in Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_log_mode</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;file&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The log mode for Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_log_level</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;info&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The log level for Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_install_lock</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to enable the install lock for Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_secret_key</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;ChangeMe1234567890&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The secret key for Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_reverse_proxy_limit</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;1&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The reverse proxy limit for Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_reverse_proxy_trusted_proxies</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;*&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The trusted proxies for reverse proxy in Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_disable_root_check</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to disable the root check in Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_disable_registration</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to disable user registration in Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_require_signin_view</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to require sign-in to view in Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_admin_username</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;admin&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The admin username for Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_admin_password</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;ChangeMeAdmin123!&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The admin password for Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_admin_email</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;admin@example.com&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The admin email for Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_enable_packages</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to allow packages registry in Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_enable_registry</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to allow container registry in Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_storage_type</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;filesystem&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The storage type for Gitea.</p>
</div>
</li>
<li>
<span class='name'>ga_instance_name</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;Your Gitea Instance&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The instance name for Gitea.</p>
</div>
</li>
</ul>
</div><div class="method_details_list">
<table class="source_code">
<tr>
<td>
<pre class="lines">
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'manifests/params.pp', line 58</span>
class confdroid_gitea::params (
# main
Array $ga_reqpackages = [&#39;git&#39;, &#39;wget&#39;, &#39;tar&#39;],
String $ga_pkg_ensure = &#39;present&#39;,
String $ga_host_fqdn = &#39;gitea.example.net&#39;,
String $ga_opt_dir = &#39;/opt/gitea&#39;,
String $ga_dl_url = &#39;https://dl.gitea.com/gitea&#39;,
String $ga_dl_version = &#39;1.25.4&#39;,
String $ga_user = &#39;git&#39;,
String $ga_domain = &#39;localhost&#39;,
String $ga_root_url = &#39;http://localhost:3000&#39;,
Boolean $ga_disable_ssh = false,
Boolean $ga_start_lfs = true,
Boolean $ga_start_ssh = false,
String $ga_instance_name = &#39;Your Gitea Instance&#39;,
# database
String $ga_db_type = &#39;postgres&#39;,
String $ga_db_host = &#39;localhost&#39;,
String $ga_db_port = &#39;5432&#39;,
String $ga_db_name = &#39;gitea&#39;,
String $ga_db_user = &#39;ChangeMe&#39;,
String $ga_db_password = &#39;ChangeMe&#39;,
Boolean $ga_log_sql = false,
String $ga_ssl_mode = &#39;require&#39;,
# logging
String $ga_log_mode = &#39;file&#39;,
String $ga_log_level = &#39;info&#39;,
# security
Boolean $ga_install_lock = false,
String $ga_secret_key = &#39;ChangeMe1234567890&#39;,
String $ga_reverse_proxy_limit = &#39;1&#39;,
String $ga_reverse_proxy_trusted_proxies = &#39;*&#39;,
Boolean $ga_disable_root_check = true,
String $ga_admin_username = &#39;admin&#39;,
String $ga_admin_password = &#39;ChangeMeAdmin123!&#39;,
String $ga_admin_email = &#39;admin@example.com&#39;,
# service
Boolean $ga_disable_registration = false,
Boolean $ga_require_signin_view = false,
Boolean $ga_enable_packages = true,
Boolean $ga_enable_registry = true,
String $ga_storage_type = &#39;filesystem&#39;,
# firewall
Boolean $ga_use_firewall = true,
String $ga_http_port = &#39;3000&#39;,
String $ga_ssh_port = &#39;22&#39;,
String $ga_order_prefix = &#39;50&#39;,
) {
# facts
$fqdn = $facts[&#39;networking&#39;][&#39;fqdn&#39;]
$domain = $facts[&#39;networking&#39;][&#39;domain&#39;]
$os_name = $facts[&#39;os&#39;][&#39;name&#39;]
$os_release = $facts[&#39;os&#39;][&#39;release&#39;][&#39;major&#39;]
# directories
$ga_working_dir =&#39;/var/lib/gitea&#39;
$ga_custom_dir = &quot;${ga_working_dir}/custom&quot;
$ga_data_dir = &quot;${ga_working_dir}/data&quot;
$ga_log_dir = &quot;${ga_working_dir}/log&quot;
$ga_tmp_dir = &quot;${ga_working_dir}/tmp&quot;
$ga_conf_dir = &#39;/etc/gitea&#39;
$ga_git_dir = &quot;${ga_data_dir}/git&quot;
$ga_repo_dir = &quot;${ga_git_dir}/repositories&quot;
$ga_uploads_dir = &quot;${ga_data_dir}/uploads&quot;
$ga_indexer_dir = &quot;${ga_data_dir}/indexers&quot;
$ga_sessions_dir = &quot;${ga_data_dir}/sessions&quot;
$ga_avatars_dir = &quot;${ga_data_dir}/avatars&quot;
$ga_repo_avatars_dir = &quot;${ga_data_dir}/repo-avatars&quot;
$ga_attachments_dir = &quot;${ga_data_dir}/attachments&quot;
$ga_lfs_dir = &quot;${ga_data_dir}/lfs&quot;
# files
$ga_config_file = &quot;${ga_conf_dir}/app.ini&quot;
$ga_config_erb = &#39;confdroid_gitea/app.ini.erb&#39;
# includes must be last
include confdroid_gitea::main::config
}</pre>
</td>
</tr>
</table>
</div>
</div>
<div id="footer">
Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>.
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink