fujin/nixarr
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
5474cfd610275c859b9173cf72c7f1409d05b837
nixarr/hugo/public/nixos/index.html
T
rasmus-kirk dd7b9e22a3 Added most of what will be needed to get this running
2024-02-20 09:12:19 +01:00

269 lines
9.2 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head><title>Options Documentation &ndash; Option Documentation for Rasmus Kirk&#39;s Nix Modules</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="UTF-8"/>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.2/css/all.min.css" integrity="sha512-1sCRPdkRXhBV2PBLUdRb4tMg1w2YPf37qatUFeS7zlBy7jJI8Lf4VHwWfZZfpXtYSLy85pkm9GaYVYMfw5BC1A==" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/academicons/1.9.1/css/academicons.min.css" integrity="sha512-b1ASx0WHgVFL5ZQhTgiPWX+68KjS38Jk87jg7pe+qC7q9YkEtFq0z7xCglv7qGIs/68d3mAp+StfC8WKC5SSAg==" crossorigin="anonymous" />
<link rel="stylesheet" href="https://rasmus-kirk.github.io/nix-modules/css/palettes/base16-dark.css">
<link rel="stylesheet" href="https://rasmus-kirk.github.io/nix-modules/css/risotto.css">
<link rel="stylesheet" href="https://rasmus-kirk.github.io/nix-modules/css/custom.css">
</head>
<body>
<div class="page">
<header class="page__header"><nav class="page__nav main-nav">
<ul>
<h1 class="page__logo"><a href="https://rasmus-kirk.github.io/nix-modules/" class="page__logo-inner">Option Documentation for Rasmus Kirk&#39;s Nix Modules</a></h1>
</ul>
</nav>
</header>
<section class="page__body">
<header class="content__header">
<h1>Options Documentation</h1>
</header>
<div class="content__body">
<h2 id="kirknixosscriptsconfigdir">kirk.nixosScripts.configDir</h2>
<p>Path to the nixos configuration.</p>
<p><em><em>Type</em></em>:
path</p>
<p><em><em>Default</em></em></p>
<pre tabindex="0"><code>&#34;/etc/nixos&#34;
</code></pre><h2 id="kirknixosscriptsenable">kirk.nixosScripts.enable</h2>
<p>Whether to enable Nixos scripts</p>
<p>Required options:</p>
<ul>
<li><code>machine</code>
.</li>
</ul>
<p><em><em>Type</em></em>:
boolean</p>
<p><em><em>Default</em></em></p>
<pre tabindex="0"><code>false
</code></pre><p><em><em>Example</em></em></p>
<pre tabindex="0"><code>true
</code></pre><h2 id="kirknixosscriptsmachine">kirk.nixosScripts.machine</h2>
<p>REQUIRED! The machine to run on.</p>
<p><em><em>Type</em></em>:
null or string</p>
<p><em><em>Default</em></em></p>
<pre tabindex="0"><code>null
</code></pre><h2 id="kirkservarracmemail">kirk.servarr.acmeMail</h2>
<p>REQUIRED! The ACME mail.</p>
<p><em><em>Type</em></em>:
null or string</p>
<p><em><em>Default</em></em></p>
<pre tabindex="0"><code>null
</code></pre><h2 id="kirkservarrdomainname">kirk.servarr.domainName</h2>
<p>REQUIRED! The domain name to host jellyfin on.</p>
<p><em><em>Type</em></em>:
null or string</p>
<p><em><em>Default</em></em></p>
<pre tabindex="0"><code>null
</code></pre><h2 id="kirkservarrenable">kirk.servarr.enable</h2>
<p>Whether to enable My servarr setup. Hosts Jellyfin on the given domain (remember domain
records/port forwarding) and hosts the following services on localhost
through a mullvad VPN:</p>
<ul>
<li>Prowlarr</li>
<li>Sonarr</li>
<li>Radarr</li>
<li>Flood/Rtorrnet</li>
</ul>
<p>Required options for this module:</p>
<ul>
<li><code>domainName</code></li>
<li><code>acmeMail</code></li>
<li><code>mullvadAcc</code></li>
</ul>
<p>Remember to read the options.</p>
<p>NOTE: The docker service to manage this executes the command <code>docker container prune -f</code> on startup for reproducibility, may cause issues
depending on your setup.</p>
<p>NOTE: This nixos module only supports the mullvad VPN, if you need
another VPN, create a PR or fork this repo!
.</p>
<p><em><em>Type</em></em>:
boolean</p>
<p><em><em>Default</em></em></p>
<pre tabindex="0"><code>false
</code></pre><p><em><em>Example</em></em></p>
<pre tabindex="0"><code>true
</code></pre><h2 id="kirkservarrgluetunextraconfig">kirk.servarr.gluetun.extraConfig</h2>
<p>Extra config for the service.</p>
<p><em><em>Type</em></em>:
attribute set</p>
<p><em><em>Default</em></em></p>
<pre tabindex="0"><code>{}
</code></pre><h2 id="kirkservarrjellyfinextraconfig">kirk.servarr.jellyfin.extraConfig</h2>
<p>Extra config for the service.</p>
<p><em><em>Type</em></em>:
attribute set</p>
<p><em><em>Default</em></em></p>
<pre tabindex="0"><code>{}
</code></pre><h2 id="kirkservarrjellyfinport">kirk.servarr.jellyfin.port</h2>
<p>Port of Jellyfin.</p>
<p><em><em>Type</em></em>:
16 bit unsigned integer; between 0 and 65535 (both inclusive)</p>
<p><em><em>Default</em></em></p>
<pre tabindex="0"><code>8096
</code></pre><h2 id="kirkservarrmediadir">kirk.servarr.mediaDir</h2>
<p>The location of the media directory for the services.</p>
<p><em><em>Type</em></em>:
path</p>
<p><em><em>Default</em></em></p>
<pre tabindex="0"><code>&#34;~/servarr&#34;
</code></pre><h2 id="kirkservarrmullvadacc">kirk.servarr.mullvadAcc</h2>
<p>REQUIRED! The location the file containing your mullvad account key.</p>
<p><em><em>Type</em></em>:
null or path</p>
<p><em><em>Default</em></em></p>
<pre tabindex="0"><code>null
</code></pre><h2 id="kirkservarrprowlarrextraconfig">kirk.servarr.prowlarr.extraConfig</h2>
<p>Extra config for the service.</p>
<p><em><em>Type</em></em>:
attribute set</p>
<p><em><em>Default</em></em></p>
<pre tabindex="0"><code>{}
</code></pre><h2 id="kirkservarrprowlarrport">kirk.servarr.prowlarr.port</h2>
<p>Port of prowlarr.</p>
<p><em><em>Type</em></em>:
16 bit unsigned integer; between 0 and 65535 (both inclusive)</p>
<p><em><em>Default</em></em></p>
<pre tabindex="0"><code>6002
</code></pre><h2 id="kirkservarrradarrextraconfig">kirk.servarr.radarr.extraConfig</h2>
<p>Extra config for the service.</p>
<p><em><em>Type</em></em>:
attribute set</p>
<p><em><em>Default</em></em></p>
<pre tabindex="0"><code>{}
</code></pre><h2 id="kirkservarrradarrport">kirk.servarr.radarr.port</h2>
<p>Port of radarr.</p>
<p><em><em>Type</em></em>:
16 bit unsigned integer; between 0 and 65535 (both inclusive)</p>
<p><em><em>Default</em></em></p>
<pre tabindex="0"><code>6004
</code></pre><h2 id="kirkservarrrfloodextraconfig">kirk.servarr.rflood.extraConfig</h2>
<p>Extra config for the service.</p>
<p><em><em>Type</em></em>:
attribute set</p>
<p><em><em>Default</em></em></p>
<pre tabindex="0"><code>{}
</code></pre><h2 id="kirkservarrrfloodport">kirk.servarr.rflood.port</h2>
<p>Port of rflood.</p>
<p><em><em>Type</em></em>:
16 bit unsigned integer; between 0 and 65535 (both inclusive)</p>
<p><em><em>Default</em></em></p>
<pre tabindex="0"><code>6001
</code></pre><h2 id="kirkservarrrfloodulimitsenable">kirk.servarr.rflood.ulimits.enable</h2>
<p>Whether to enable Enable rtorrent ulimits. I had a bug that caused rtorrent to fail
and log <code>std::bad_alloc</code>. Setting ulimits for this service fixed
the issue. You probably don&rsquo;t want to set this unless you have
similar issues.See link below for more info:</p>
<p><a href="https://stackoverflow.com/questions/75536471/rtorrent-docker-container-failing-to-start-saying-stdbad-alloc">https://stackoverflow.com/questions/75536471/rtorrent-docker-container-failing-to-start-saying-stdbad-alloc</a>
.</p>
<p><em><em>Type</em></em>:
boolean</p>
<p><em><em>Default</em></em></p>
<pre tabindex="0"><code>false
</code></pre><p><em><em>Example</em></em></p>
<pre tabindex="0"><code>true
</code></pre><h2 id="kirkservarrrfloodulimitshard">kirk.servarr.rflood.ulimits.hard</h2>
<p>The hard limit.</p>
<p><em><em>Type</em></em>:
unsigned integer, meaning &gt;=0</p>
<p><em><em>Default</em></em></p>
<pre tabindex="0"><code>1024
</code></pre><h2 id="kirkservarrrfloodulimitssoft">kirk.servarr.rflood.ulimits.soft</h2>
<p>The soft limit.</p>
<p><em><em>Type</em></em>:
unsigned integer, meaning &gt;=0</p>
<p><em><em>Default</em></em></p>
<pre tabindex="0"><code>1024
</code></pre><h2 id="kirkservarrsonarrextraconfig">kirk.servarr.sonarr.extraConfig</h2>
<p>Extra config for the service.</p>
<p><em><em>Type</em></em>:
attribute set</p>
<p><em><em>Default</em></em></p>
<pre tabindex="0"><code>{}
</code></pre><h2 id="kirkservarrsonarrport">kirk.servarr.sonarr.port</h2>
<p>Port of sonarr.</p>
<p><em><em>Type</em></em>:
16 bit unsigned integer; between 0 and 65535 (both inclusive)</p>
<p><em><em>Default</em></em></p>
<pre tabindex="0"><code>6003
</code></pre><h2 id="kirkservarrstatedir">kirk.servarr.stateDir</h2>
<p>The location of the state directory for the services.</p>
<p><em><em>Type</em></em>:
path</p>
<p><em><em>Default</em></em></p>
<pre tabindex="0"><code>&#34;~/.local/state&#34;
</code></pre><h2 id="kirkservarrtimezone">kirk.servarr.timezone</h2>
<p>Your timezone, used for logging purposes.</p>
<p><em><em>Type</em></em>:
string</p>
<p><em><em>Default</em></em></p>
<pre tabindex="0"><code>&#34;Etc/UTC&#34;
</code></pre>
</div>
<footer class="content__footer"></footer>
</section>
<section class="page__aside">
<div class="aside__about">
<ul class="aside__social-links">
</ul>
</div>
<hr>
<div class="aside__content">
<p>
By Rasmus Kirk,
2023-12-07
</p>
</div>
</section>
<footer class="page__footer"><p>
</p>
<br /><br />
<p class="copyright"></p>
<p class="advertisement">Powered by <a href="https://gohugo.io/">hugo</a> and <a href="https://github.com/joeroe/risotto">risotto</a>.</p>
</footer>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink