Files
confdroid_gitea/doc/puppet_classes/confdroid_gitea_3A_3Aparams.html

350 lines
7.8 KiB
HTML

<!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_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_working_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 working 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>
</ul>
</div><div class="method_details_list">
<table class="source_code">
<tr>
<td>
<pre class="lines">
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'manifests/params.pp', line 15</span>
class confdroid_gitea::params (
# main
String $ga_host_fqdn = &#39;gitea.example.net&#39;,
String $ga_working_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;,
# 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;]
# 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>