17 lines
16 KiB
HTML
17 lines
16 KiB
HTML
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-unraid_install">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v2.1.0">
|
||
<title data-rh="true">Install ThreeTwo! on unRaid | ThreeTwo!</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://rishighan.github.io/threetwo-docs/docs/unraid_install"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Install ThreeTwo! on unRaid | ThreeTwo!"><meta data-rh="true" name="description" content="Notes"><meta data-rh="true" property="og:description" content="Notes"><link data-rh="true" rel="icon" href="/threetwo-docs/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://rishighan.github.io/threetwo-docs/docs/unraid_install"><link data-rh="true" rel="alternate" href="https://rishighan.github.io/threetwo-docs/docs/unraid_install" hreflang="en"><link data-rh="true" rel="alternate" href="https://rishighan.github.io/threetwo-docs/docs/unraid_install" hreflang="x-default"><link rel="alternate" type="application/rss+xml" href="/threetwo-docs/blog/rss.xml" title="ThreeTwo! RSS Feed">
|
||
<link rel="alternate" type="application/atom+xml" href="/threetwo-docs/blog/atom.xml" title="ThreeTwo! Atom Feed"><link rel="stylesheet" href="/threetwo-docs/assets/css/styles.e137d125.css">
|
||
<link rel="preload" href="/threetwo-docs/assets/js/runtime~main.3f3e3a68.js" as="script">
|
||
<link rel="preload" href="/threetwo-docs/assets/js/main.ccdf4749.js" as="script">
|
||
</head>
|
||
<body class="navigation-with-keyboard">
|
||
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
|
||
<div role="region" aria-label="theme.common.skipToMainContent"><a href="#" class="skipToContent_fXgn">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Navigation bar toggle" class="navbar__toggle clean-btn" type="button" tabindex="0"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/threetwo-docs/"><div class="navbar__logo"><img src="/threetwo-docs/img/threetwo.png" alt="My Site Logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/threetwo-docs/img/threetwo.png" alt="My Site Logo" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate">ThreeTwo!</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/threetwo-docs/docs/intro">Quick Start</a><a class="navbar__item navbar__link" href="/threetwo-docs/blog">Blog</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/rishighan/threetwo" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><div class="searchBox_ZlJk"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebar_njMd"><nav class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/threetwo-docs/docs/intro">Introduction</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/threetwo-docs/docs/unRAID_dockercompose">Install ThreeTwo! on unRAID with the docker-compose plugin</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" href="/threetwo-docs/docs/unraid_install">Install ThreeTwo! on unRaid</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/threetwo-docs/docs/resources">Resources & Help</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/threetwo-docs/docs/architecture">Technical Architecture</a></li></ul></nav></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/threetwo-docs/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_OVgt"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Install ThreeTwo! on unRaid</span><meta itemprop="position" content="1"></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Install ThreeTwo! on unRaid</h1></header><h3 class="anchor anchorWithStickyNavbar_LWe7" id="notes">Notes<a class="hash-link" href="#notes" title="Direct link to heading"></a></h3><ul><li>Currently, <code>ThreeTwo!</code> is installed along with its dependencies using <code>docker-compose</code>. The easiest way to install it on <code>unRAID</code> is to use a VM.</li><li>Skip the VM creation steps, if you already have a Debian VM</li></ul><h3 class="anchor anchorWithStickyNavbar_LWe7" id="pre-requisites">Pre-requisites<a class="hash-link" href="#pre-requisites" title="Direct link to heading"></a></h3><p>This guide assumes the following is installed or readily available:</p><ul><li><code>unRaid 6.9.2</code> (this version was tested against <code>6.9.2</code>)</li><li><code>Debian 10.x</code> (Grab the install <code>.iso</code> <a href="https://cdimage.debian.org/debian-cd/current/amd64/iso-cd/debian-11.1.0-amd64-netinst.iso" target="_blank" rel="noopener noreferrer">here</a>)</li></ul><h3 class="anchor anchorWithStickyNavbar_LWe7" id="getting-the-vm-up-and-running">Getting the VM up and running<a class="hash-link" href="#getting-the-vm-up-and-running" title="Direct link to heading"></a></h3><ol><li>Download the <code>Debian</code> install <code>.iso</code></li><li>Place it in a folder accessible by the VM</li><li>Go to the <code>VM</code> tab in your <code>unRaid</code> navigation</li><li>Click <code>Add VM</code></li><li>From the list presented to you, click <code>Debian</code> under <code>Linux</code></li><li>On the VM configration page, enter the desired options for memory, CPU cores, vdisk allocation</li><li>Make sure that you have set the volume containing the comics correctly for <code>Unraid Share</code></li><li>Make sure that you have also set the <code>Unraid Mount tag</code> option</li><li>Make sure that the network bridge is set to <code>br0</code></li><li>Set a password for <code>VNC</code> so you can follow through with a graphical install if you so wish</li></ol><h3 class="anchor anchorWithStickyNavbar_LWe7" id="installing-debian-on-the-vm">Installing Debian on the VM<a class="hash-link" href="#installing-debian-on-the-vm" title="Direct link to heading"></a></h3><ol><li>Launch the VM via <code>VNC Remote</code> option</li><li>Follow the steps of the graphical installer</li><li>Create a <code>root</code> user and a normal <code>user</code> and set the passwords for both</li></ol><h3 class="anchor anchorWithStickyNavbar_LWe7" id="docker-pre-requisites">Docker pre-requisites<a class="hash-link" href="#docker-pre-requisites" title="Direct link to heading"></a></h3><ol><li><a href="https://unix.stackexchange.com/questions/354928/bash-sudo-command-not-found" target="_blank" rel="noopener noreferrer">Make sure you have</a> <code>sudo</code></li><li>Make sure you have <code>ssh</code> access for the user you created earlier</li><li><code>ssh</code> into the VM as the non-root user</li><li>Install <a href="https://docs.docker.com/engine/install/debian/" target="_blank" rel="noopener noreferrer">Docker Engine</a></li><li>Install <a href="https://docs.docker.com/compose/install/#install-compose-on-linux-systems" target="_blank" rel="noopener noreferrer">docker-compose</a></li><li>Verify that <code>docker</code> and <code>docker-compose</code> commands work</li></ol><h3 class="anchor anchorWithStickyNavbar_LWe7" id="installation">Installation<a class="hash-link" href="#installation" title="Direct link to heading"></a></h3><ol><li><p>Clone the repo: <code>git clone https://github.com/rishighan/threetwo.git</code></p></li><li><p>Change the directory: <code>cd threetwo</code></p></li><li><p>Create directories within <code>threetwo</code></p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token function" style="color:#d73a49">mkdir</span><span class="token plain"> comics userdata</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token function" style="color:#d73a49">mkdir</span><span class="token plain"> userdata/covers userdata/temporary userdata/expanded</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></li><li><p>Create an external docker network using <code>sudo docker network create proxy</code></p></li><li><p>Run <code>sudo docker-compose up --build -d</code></p></li><li><p>Wait for a hot minute</p></li></ol><h3 class="anchor anchorWithStickyNavbar_LWe7" id="post-install-checks">Post-install checks<a class="hash-link" href="#post-install-checks" title="Direct link to heading"></a></h3><ol><li>Once the <code>docker-compose up</code> command successfully completes, you can check the spun-up containers using <code>docker ps</code></li><li></li></ol></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/facebook/docusaurus/edit/main/website/docs/unraid_install.md" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_vwxv"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><a class="pagination-nav__link pagination-nav__link--prev" href="/threetwo-docs/docs/unRAID_dockercompose"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Install ThreeTwo! on unRAID with the docker-compose plugin</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/threetwo-docs/docs/resources"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Resources & Help</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#notes" class="table-of-contents__link toc-highlight">Notes</a></li><li><a href="#pre-requisites" class="table-of-contents__link toc-highlight">Pre-requisites</a></li><li><a href="#getting-the-vm-up-and-running" class="table-of-contents__link toc-highlight">Getting the VM up and running</a></li><li><a href="#installing-debian-on-the-vm" class="table-of-contents__link toc-highlight">Installing Debian on the VM</a></li><li><a href="#docker-pre-requisites" class="table-of-contents__link toc-highlight">Docker pre-requisites</a></li><li><a href="#installation" class="table-of-contents__link toc-highlight">Installation</a></li><li><a href="#post-install-checks" class="table-of-contents__link toc-highlight">Post-install checks</a></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/threetwo-docs/docs/intro">Tutorial</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/rishighan/threetwo" target="_blank" rel="noopener noreferrer" class="footer__link-item">Github<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://discord.gg/DbpcSNuM" target="_blank" rel="noopener noreferrer" class="footer__link-item">Discord<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/threetwo-docs/blog">Blog</a></li><li class="footer__item"><a href="https://rishighan.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Rishi Ghan<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2022 Quasar Software, LLC. Built with Docusaurus.</div></div></div></footer></div>
|
||
<script src="/threetwo-docs/assets/js/runtime~main.3f3e3a68.js"></script>
|
||
<script src="/threetwo-docs/assets/js/main.ccdf4749.js"></script>
|
||
</body>
|
||
</html> |