Deployed 9e3bc8e to v0.7.3 with MkDocs 1.5.3 and mike 1.1.2

gh-pages
GitHub Action 8 months ago
parent bb2650d066
commit e0677a8e4e

@ -4782,25 +4782,26 @@
</span><span id="__span-4-8"><a id="__codelineno-4-8" name="__codelineno-4-8" href="#__codelineno-4-8"></a><span class="w"> </span><span class="nt">gethomepage.dev/description</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Media Server</span>
</span><span id="__span-4-9"><a id="__codelineno-4-9" name="__codelineno-4-9" href="#__codelineno-4-9"></a><span class="w"> </span><span class="nt">gethomepage.dev/group</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Media</span>
</span><span id="__span-4-10"><a id="__codelineno-4-10" name="__codelineno-4-10" href="#__codelineno-4-10"></a><span class="w"> </span><span class="nt">gethomepage.dev/icon</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">emby.png</span>
</span><span id="__span-4-11"><a id="__codelineno-4-11" name="__codelineno-4-11" href="#__codelineno-4-11"></a><span class="w"> </span><span class="nt">gethomepage.dev/name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Emby</span>
</span><span id="__span-4-12"><a id="__codelineno-4-12" name="__codelineno-4-12" href="#__codelineno-4-12"></a><span class="w"> </span><span class="nt">gethomepage.dev/widget.type</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;emby&quot;</span>
</span><span id="__span-4-13"><a id="__codelineno-4-13" name="__codelineno-4-13" href="#__codelineno-4-13"></a><span class="w"> </span><span class="nt">gethomepage.dev/widget.url</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://emby.example.com&quot;</span>
</span><span id="__span-4-14"><a id="__codelineno-4-14" name="__codelineno-4-14" href="#__codelineno-4-14"></a><span class="w"> </span><span class="nt">gethomepage.dev/pod-selector</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;&quot;</span>
</span><span id="__span-4-15"><a id="__codelineno-4-15" name="__codelineno-4-15" href="#__codelineno-4-15"></a><span class="w"> </span><span class="nt">gethomepage.dev/weight</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10</span><span class="w"> </span><span class="c1"># optional</span>
</span><span id="__span-4-16"><a id="__codelineno-4-16" name="__codelineno-4-16" href="#__codelineno-4-16"></a><span class="nt">spec</span><span class="p">:</span>
</span><span id="__span-4-17"><a id="__codelineno-4-17" name="__codelineno-4-17" href="#__codelineno-4-17"></a><span class="w"> </span><span class="nt">entryPoints</span><span class="p">:</span>
</span><span id="__span-4-18"><a id="__codelineno-4-18" name="__codelineno-4-18" href="#__codelineno-4-18"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">websecure</span>
</span><span id="__span-4-19"><a id="__codelineno-4-19" name="__codelineno-4-19" href="#__codelineno-4-19"></a><span class="w"> </span><span class="nt">routes</span><span class="p">:</span>
</span><span id="__span-4-20"><a id="__codelineno-4-20" name="__codelineno-4-20" href="#__codelineno-4-20"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Rule</span>
</span><span id="__span-4-21"><a id="__codelineno-4-21" name="__codelineno-4-21" href="#__codelineno-4-21"></a><span class="w"> </span><span class="nt">match</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Host(`emby.example.com`)</span>
</span><span id="__span-4-22"><a id="__codelineno-4-22" name="__codelineno-4-22" href="#__codelineno-4-22"></a><span class="w"> </span><span class="nt">services</span><span class="p">:</span>
</span><span id="__span-4-23"><a id="__codelineno-4-23" name="__codelineno-4-23" href="#__codelineno-4-23"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Service</span>
</span><span id="__span-4-24"><a id="__codelineno-4-24" name="__codelineno-4-24" href="#__codelineno-4-24"></a><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">emby</span>
</span><span id="__span-4-25"><a id="__codelineno-4-25" name="__codelineno-4-25" href="#__codelineno-4-25"></a><span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">emby</span>
</span><span id="__span-4-26"><a id="__codelineno-4-26" name="__codelineno-4-26" href="#__codelineno-4-26"></a><span class="w"> </span><span class="nt">port</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">8080</span>
</span><span id="__span-4-27"><a id="__codelineno-4-27" name="__codelineno-4-27" href="#__codelineno-4-27"></a><span class="w"> </span><span class="nt">scheme</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">http</span>
</span><span id="__span-4-28"><a id="__codelineno-4-28" name="__codelineno-4-28" href="#__codelineno-4-28"></a><span class="w"> </span><span class="nt">strategy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">RoundRobin</span>
</span><span id="__span-4-29"><a id="__codelineno-4-29" name="__codelineno-4-29" href="#__codelineno-4-29"></a><span class="w"> </span><span class="nt">weight</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10</span>
</span><span id="__span-4-11"><a id="__codelineno-4-11" name="__codelineno-4-11" href="#__codelineno-4-11"></a><span class="w"> </span><span class="nt">gethomepage.dev/app</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">emby-app</span><span class="w"> </span><span class="c1"># optional, may be needed if app.kubernetes.io/name != ingress metadata.name</span>
</span><span id="__span-4-12"><a id="__codelineno-4-12" name="__codelineno-4-12" href="#__codelineno-4-12"></a><span class="w"> </span><span class="nt">gethomepage.dev/name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Emby</span>
</span><span id="__span-4-13"><a id="__codelineno-4-13" name="__codelineno-4-13" href="#__codelineno-4-13"></a><span class="w"> </span><span class="nt">gethomepage.dev/widget.type</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;emby&quot;</span>
</span><span id="__span-4-14"><a id="__codelineno-4-14" name="__codelineno-4-14" href="#__codelineno-4-14"></a><span class="w"> </span><span class="nt">gethomepage.dev/widget.url</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://emby.example.com&quot;</span>
</span><span id="__span-4-15"><a id="__codelineno-4-15" name="__codelineno-4-15" href="#__codelineno-4-15"></a><span class="w"> </span><span class="nt">gethomepage.dev/pod-selector</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;&quot;</span>
</span><span id="__span-4-16"><a id="__codelineno-4-16" name="__codelineno-4-16" href="#__codelineno-4-16"></a><span class="w"> </span><span class="nt">gethomepage.dev/weight</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10</span><span class="w"> </span><span class="c1"># optional</span>
</span><span id="__span-4-17"><a id="__codelineno-4-17" name="__codelineno-4-17" href="#__codelineno-4-17"></a><span class="nt">spec</span><span class="p">:</span>
</span><span id="__span-4-18"><a id="__codelineno-4-18" name="__codelineno-4-18" href="#__codelineno-4-18"></a><span class="w"> </span><span class="nt">entryPoints</span><span class="p">:</span>
</span><span id="__span-4-19"><a id="__codelineno-4-19" name="__codelineno-4-19" href="#__codelineno-4-19"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">websecure</span>
</span><span id="__span-4-20"><a id="__codelineno-4-20" name="__codelineno-4-20" href="#__codelineno-4-20"></a><span class="w"> </span><span class="nt">routes</span><span class="p">:</span>
</span><span id="__span-4-21"><a id="__codelineno-4-21" name="__codelineno-4-21" href="#__codelineno-4-21"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Rule</span>
</span><span id="__span-4-22"><a id="__codelineno-4-22" name="__codelineno-4-22" href="#__codelineno-4-22"></a><span class="w"> </span><span class="nt">match</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Host(`emby.example.com`)</span>
</span><span id="__span-4-23"><a id="__codelineno-4-23" name="__codelineno-4-23" href="#__codelineno-4-23"></a><span class="w"> </span><span class="nt">services</span><span class="p">:</span>
</span><span id="__span-4-24"><a id="__codelineno-4-24" name="__codelineno-4-24" href="#__codelineno-4-24"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Service</span>
</span><span id="__span-4-25"><a id="__codelineno-4-25" name="__codelineno-4-25" href="#__codelineno-4-25"></a><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">emby</span>
</span><span id="__span-4-26"><a id="__codelineno-4-26" name="__codelineno-4-26" href="#__codelineno-4-26"></a><span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">emby</span>
</span><span id="__span-4-27"><a id="__codelineno-4-27" name="__codelineno-4-27" href="#__codelineno-4-27"></a><span class="w"> </span><span class="nt">port</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">8080</span>
</span><span id="__span-4-28"><a id="__codelineno-4-28" name="__codelineno-4-28" href="#__codelineno-4-28"></a><span class="w"> </span><span class="nt">scheme</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">http</span>
</span><span id="__span-4-29"><a id="__codelineno-4-29" name="__codelineno-4-29" href="#__codelineno-4-29"></a><span class="w"> </span><span class="nt">strategy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">RoundRobin</span>
</span><span id="__span-4-30"><a id="__codelineno-4-30" name="__codelineno-4-30" href="#__codelineno-4-30"></a><span class="w"> </span><span class="nt">weight</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10</span>
</span></code></pre></div>
<p>If the <code>href</code> attribute is not present, Homepage will ignore the specific IngressRoute.</p>
<h2 id="caveats">Caveats</h2>

@ -5542,7 +5542,7 @@ More information about prefixed icons can be found in <a href="../services/#icon
<li><code>basic</code> shows either UP or DOWN for ping</li>
</ul>
<p>For example:</p>
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-33-1"><a id="__codelineno-33-1" name="__codelineno-33-1" href="#__codelineno-33-1"></a><span class="nt">statusStyle</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;dot&#39;</span>
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-33-1"><a id="__codelineno-33-1" name="__codelineno-33-1" href="#__codelineno-33-1"></a><span class="nt">statusStyle</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;dot&quot;</span>
</span></code></pre></div>
<p>or per-service (<code>services.yaml</code>) with:</p>
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-34-1"><a id="__codelineno-34-1" name="__codelineno-34-1" href="#__codelineno-34-1"></a><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">Example Service</span><span class="p">:</span>

@ -4663,46 +4663,37 @@
<li>In the UNRAID webGUI, go to the <strong>Apps</strong> tab.</li>
<li>In the search bar, search for <code>homepage</code>.</li>
<li>Click on <strong>Install</strong>.</li>
<li>Change the parameters to your liking.<ul>
<li>Change the parameters to your liking.</li>
<li>Click on <strong>APPLY</strong>.</li>
</ul>
</li>
</ul>
<h2 id="run-the-container">Run the Container</h2>
<ul>
<li>While the container is running, open the WebUI.<ul>
<li>While the container is running, open the WebUI.</li>
<li>Opening the page will generate the configuration files.</li>
</ul>
</li>
</ul>
<p>You may need to set the permissions of the folders to be able to edit the files.</p>
<ul>
<li>Click on the Homepage icon.</li>
<li>Click on <strong>Console</strong>.<ul>
<li>Click on <strong>Console</strong>.</li>
<li>Enter <code>chmod -R u-x,go-rwx,go+u,ugo+X /app/config</code> and press <strong>Enter</strong>.</li>
<li>Enter <code>chmod -R u-x,go-rwx,go+u,ugo+X /app/public/icons</code> and press <strong>Enter</strong>.</li>
<li>Enter <code>chown -R nobody:users /app/config</code> and press <strong>Enter</strong>.</li>
<li>Enter <code>chown -R nobody:users /app/public/icons</code> and press <strong>Enter</strong>.</li>
</ul>
</li>
</ul>
<h2 id="some-other-notes">Some Other Notes</h2>
<ul>
<li>
<p>To use the <a href="../../configs/docker/">Docker integration</a>, you only need to use the <code>container:</code> parameter. There is no need to set the server.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>To view detailed container statistics (CPU, RAM, etc.), or if you use a remote docker socket, <code>container:</code> will still need to be set. For example:</p>
</div>
<li>To use the <a href="../../configs/docker/">Docker integration</a>, you only need to use the <code>container:</code> parameter. There is no need to set the server.</li>
</ul>
<p>!!! note</p>
<div class="language-text highlight"><pre><span></span><code> To view detailed container statistics (CPU, RAM, etc.), or if you use a remote docker socket, `container:` will still need to be set. For example:
</code></pre></div>
<div class="language-text highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a> - Plex:
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> icon: /icons/plex.png
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> href: https://app.plex.com
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> container: plex
</span></code></pre></div>
</li>
<li>
<p>When you upload a new image into the <strong>/images</strong> folder, you will need to restart the container for it to show up in the WebUI. Please see the <a href="../../configs/services/#icons">service icons</a> for more information.</p>
</li>
<ul>
<li>When you upload a new image into the <strong>/images</strong> folder, you will need to restart the container for it to show up in the WebUI. Please see the <a href="../../configs/services/#icons">service icons</a> for more information.</li>
</ul>

@ -4485,6 +4485,19 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#code-formatting-with-pre-commit-hooks" class="md-nav__link">
<span class="md-ellipsis">
<span class="md-typeset">
Code formatting with pre-commit hooks
</span>
</span>
</a>
</li>
<li class="md-nav__item">
@ -4616,6 +4629,19 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#code-formatting-with-pre-commit-hooks" class="md-nav__link">
<span class="md-ellipsis">
<span class="md-typeset">
Code formatting with pre-commit hooks
</span>
</span>
</a>
</li>
<li class="md-nav__item">
@ -4671,6 +4697,12 @@
<p>Once dependencies have been installed you can lint your code with</p>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>pnpm<span class="w"> </span>lint
</span></code></pre></div>
<h2 id="code-formatting-with-pre-commit-hooks">Code formatting with pre-commit hooks</h2>
<p>To ensure a consistent style and formatting across the project source, the project utilizes Git <a href="https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks"><code>pre-commit</code></a> hooks to perform some formatting and linting before a commit is allowed.
That way, everyone uses the same style and some common issues can be caught early on.</p>
<p>Once installed, hooks will run when you commit. If the formatting isn't quite right or a linter catches something, the commit will be rejected.
You'll need to look at the output and fix the issue. Some hooks will format failing files, so all you need to do is <code>git add</code> those files again
and retry your commit.</p>
<h2 id="service-widget-guidelines">Service Widget Guidelines</h2>
<p>To ensure cohesiveness of various widgets, the following should be used as a guide for developing new widgets:</p>
<ul>

File diff suppressed because one or more lines are too long

Binary file not shown.

@ -4544,12 +4544,10 @@
<li>Under the <code>User Groups</code> tab of the user config dialogue check the box for <code>Administrators</code>.</li>
<li>On the <code>Permissions</code> tab check the top box for <code>No Access</code>, effectively prohibiting the user from accessing anything in the shared folders.</li>
<li>Under <code>Applications</code> check the box next to <code>Deny</code> in the header to explicitly prohibit login to all applications.</li>
<li>Now <em>only</em> allow login to the <code>Download Station</code> application, either by<ul>
<li>Now <em>only</em> allow login to the <code>Download Station</code> application, either by</li>
<li>unchecking <code>Deny</code> in the respective row, or (if inheriting permission doesn't work because of other group settings)</li>
<li>checking <code>Allow</code> for this app, or</li>
<li>checking <code>By IP</code> for this app to limit the source of login attempts to one or more IP addresses/subnets.</li>
</ul>
</li>
<li>When the <code>Preview</code> column shows <code>Allow</code> in the <code>Download Station</code> row, click <code>Save</code>.</li>
</ol>
<p>Now configure the widget with the correct login information and test it.</p>

@ -4540,17 +4540,13 @@
<p>Up to a maximum of four custom states and/or templates can be queried via the <code>custom</code> property like in the example below.
The <code>custom</code> property will have no effect as long as the <code>fields</code> property is defined.</p>
<ul>
<li><code>state</code> will query the state of the specified <code>entity_id</code><ul>
<li><code>state</code> will query the state of the specified <code>entity_id</code></li>
<li>state labels and values can be user defined and may reference entity attributes in curly brackets</li>
<li>if no state label is defined it will default to <code>"{attributes.friendly_name}"</code></li>
<li>if no state value is defined it will default to <code>"{state} {attributes.unit_of_measurement}"</code></li>
</ul>
</li>
<li><code>template</code> will query the specified template, see (Home Assistant Templating)[https://www.home-assistant.io/docs/configuration/templating]<ul>
<li><code>template</code> will query the specified template, see (Home Assistant Templating)[https://www.home-assistant.io/docs/configuration/templating]</li>
<li>if no template label is defined it will be empty</li>
</ul>
</li>
</ul>
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nt">widget</span><span class="p">:</span>
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">homeassistant</span>
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">http://homeassistant.host.or.ip:port</span>

@ -4542,20 +4542,16 @@
<li>Click the Create button</li>
<li>Name the group something informative, like api-ro-users</li>
<li>Click on the Permissions "folder"</li>
<li>Click Add -&gt; Group Permission<ul>
<li>Click Add -&gt; Group Permission</li>
<li>Path: /</li>
<li>Group: group from bullet 4 above</li>
<li>Role: PVEAuditor</li>
<li>Propagate: Checked</li>
</ul>
</li>
<li>Expand Permissions, click on Users</li>
<li>Click the Add button<ul>
<li>Click the Add button</li>
<li>User name: something informative like <code>api</code></li>
<li>Realm: Linux PAM standard authentication</li>
<li>Group: group from bullet 4 above</li>
</ul>
</li>
<li>Expand Permissions, click on API Tokens</li>
<li>Click the Add button<ul>
<li>User: user from bullet 8 above</li>

Loading…
Cancel
Save