Files
threetwo-docs/docs/unRAID_dockercompose/index.html
2022-05-17 13:24:09 -07:00

18 lines
13 KiB
HTML

<!doctype html>
<html class="docs-version-current" lang="en" dir="ltr">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="generator" content="Docusaurus v2.0.0-beta.6">
<link rel="alternate" type="application/rss+xml" href="/threetwo-docs/blog/rss.xml" title="ThreeTwo! Blog RSS Feed">
<link rel="alternate" type="application/atom+xml" href="/threetwo-docs/blog/atom.xml" title="ThreeTwo! Blog Atom Feed"><title data-react-helmet="true">Install ThreeTwo! on unRAID with the docker-compose plugin | ThreeTwo!</title><meta data-react-helmet="true" name="twitter:card" content="summary_large_image"><meta data-react-helmet="true" property="og:url" content="https://rishighan.github.io/threetwo-docs/docs/unRAID_dockercompose"><meta data-react-helmet="true" name="docusaurus_locale" content="en"><meta data-react-helmet="true" name="docusaurus_version" content="current"><meta data-react-helmet="true" name="docusaurus_tag" content="docs-default-current"><meta data-react-helmet="true" property="og:title" content="Install ThreeTwo! on unRAID with the docker-compose plugin | ThreeTwo!"><meta data-react-helmet="true" name="description" content="Notes:"><meta data-react-helmet="true" property="og:description" content="Notes:"><link data-react-helmet="true" rel="shortcut icon" href="/threetwo-docs/img/favicon.ico"><link data-react-helmet="true" rel="canonical" href="https://rishighan.github.io/threetwo-docs/docs/unRAID_dockercompose"><link data-react-helmet="true" rel="alternate" href="https://rishighan.github.io/threetwo-docs/docs/unRAID_dockercompose" hreflang="en"><link data-react-helmet="true" rel="alternate" href="https://rishighan.github.io/threetwo-docs/docs/unRAID_dockercompose" hreflang="x-default"><link rel="stylesheet" href="/threetwo-docs/assets/css/styles.95fcde6a.css">
<link rel="preload" href="/threetwo-docs/assets/js/runtime~main.6aa04b35.js" as="script">
<link rel="preload" href="/threetwo-docs/assets/js/main.8fb66527.js" as="script">
</head>
<body>
<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><a href="#" class="skipToContent_1oUP">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/"><img src="/threetwo-docs/img/threetwo.png" alt="My Site Logo" class="themedImage_1VuW themedImage--light_3UqQ navbar__logo"><img src="/threetwo-docs/img/threetwo.png" alt="My Site Logo" class="themedImage_1VuW themedImage--dark_hz6m navbar__logo"><b class="navbar__title">ThreeTwo!</b></a><a class="navbar__item navbar__link navbar__link--active" href="/threetwo-docs/docs/intro">Tutorial</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/facebook/docusaurus" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link"><span>GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_3J9K"><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></span></a><div class="react-toggle toggle_3Zt9 react-toggle--disabled"><div class="react-toggle-track" role="button" tabindex="-1"><div class="react-toggle-track-check"><span class="toggle_71bT">🌜</span></div><div class="react-toggle-track-x"><span class="toggle_71bT">🌞</span></div><div class="react-toggle-thumb"></div></div><input type="checkbox" class="react-toggle-screenreader-only" aria-label="Switch between dark and light mode"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div class="main-wrapper docs-wrapper docs-doc-page"><div class="docPage_31aa"><button class="clean-btn backToTopButton_35hR" type="button"><svg viewBox="0 0 24 24" width="28"><path d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z" fill="currentColor"></path></svg></button><aside class="docSidebarContainer_3Kbt"><div class="sidebar_15mo"><nav class="menu thin-scrollbar menu_Bmed menuWithAnnouncementBar_2WvA"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link menu__list-item"><a class="menu__link" href="/threetwo-docs/docs/intro">Introduction</a></li><li class="theme-doc-sidebar-item-link menu__list-item"><a class="menu__link menu__link--active" aria-current="page" href="/threetwo-docs/docs/unRAID_dockercompose">Install ThreeTwo! on unRAID with the docker-compose plugin</a></li><li class="theme-doc-sidebar-item-link menu__list-item"><a class="menu__link" href="/threetwo-docs/docs/resources">Resources &amp; Help</a></li><li class="theme-doc-sidebar-item-link menu__list-item"><a class="menu__link" href="/threetwo-docs/docs/unraid_install">Install ThreeTwo! on unRaid</a></li></ul></nav></div></aside><main class="docMainContainer_3ufF"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_3FnS"><div class="docItemContainer_33ec"><article><div class="tocCollapsible_1PrD theme-doc-toc-mobile tocMobile_3Hoh"><button type="button" class="clean-btn tocCollapsibleButton_2O1e">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Install ThreeTwo! on unRAID with the docker-compose plugin</h1></header><h3><a aria-hidden="true" tabindex="-1" class="anchor anchor__h3 anchorWithStickyNavbar_31ik" id="notes"></a>Notes:<a class="hash-link" href="#notes" title="Direct link to heading">#</a></h3><p>This guide goes over ThreeTwo! installation on unRAID using the <a href="https://forums.unRAID.net/topic/114415-plugin-docker-compose-manager/" target="_blank" rel="noopener noreferrer">docker-compose manager</a> plugin. Currently this is the recommended approach for unRAID users.</p><p>With the help of this plugin, you are able to pull the entire ThreeTwo! <code>docker-compose</code> stack up, down with the click of a button. It abstracts away a lot of complexity of writing out commands in the console.</p><p>That said, the plugin is still in beta, so you may experience strange behavior. </p><h3><a aria-hidden="true" tabindex="-1" class="anchor anchor__h3 anchorWithStickyNavbar_31ik" id="pre-requisites"></a>Pre-requisites:<a class="hash-link" href="#pre-requisites" title="Direct link to heading">#</a></h3><p>First things first, let&#x27;s go over what the pre-requisites are:</p><ol><li>The <code>docker-compose</code> configuration for ThreeTwo! now resides in its own repo here: <a href="https://github.com/rishighan/threetwo-docker-compose" target="_blank" rel="noopener noreferrer">https://github.com/rishighan/threetwo-docker-compose</a> You will be using this as a reference.</li><li>A working <code>AirDC++</code> install is necessary for <code>DC++</code> searching/downloading to work. You can install it through the unRAID via the CA store or via a <a href="https://airdcpp.net/download#linux-nas-docker-other" target="_blank" rel="noopener noreferrer">docker</a></li><li><code>comics</code> and <code>userdata</code> folders.</li><li>The <code>comics</code> folder <em>must</em> be the folder <code>AirDC++</code> downloads comics to.</li><li>You can create a <code>userdata</code> folder under <code>appdata</code> where unRAID usually stores app configuration.</li><li>To get ComicVine to work for metadata scraping and other functions, you <em>must</em> have a ComicVine API key. You can get one here. Metadata scraping will not work unless you supply an API key.</li></ol><h3><a aria-hidden="true" tabindex="-1" class="anchor anchor__h3 anchorWithStickyNavbar_31ik" id="installation"></a>Installation:<a class="hash-link" href="#installation" title="Direct link to heading">#</a></h3><ol><li>Install the <code>docker-compose manager</code> plugin from the unRAID CA store. After installation, you can find the plugin UI under the <code>Docker</code> tab.</li><li>Create a new stack, and you will see a textarea populated with a sample <code>docker-compose</code> configuration.</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_dockercompose.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_2_ui" 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_13-_"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><div class="pagination-nav__item"><a class="pagination-nav__link" href="/threetwo-docs/docs/intro"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">« Introduction</div></a></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/threetwo-docs/docs/resources"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Resources &amp; Help »</div></a></div></nav></div></div><div class="col col--3"><div class="tableOfContents_35-E thin-scrollbar"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#notes" class="table-of-contents__link">Notes:</a></li><li><a href="#pre-requisites" class="table-of-contents__link">Pre-requisites:</a></li><li><a href="#installation" class="table-of-contents__link">Installation:</a></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items"><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"><li class="footer__item"><a href="https://stackoverflow.com/questions/tagged/docusaurus" target="_blank" rel="noopener noreferrer" class="footer__link-item"><span>Stack Overflow<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_3J9K"><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></span></a></li><li class="footer__item"><a href="https://discordapp.com/invite/docusaurus" target="_blank" rel="noopener noreferrer" class="footer__link-item"><span>Discord<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_3J9K"><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></span></a></li><li class="footer__item"><a href="https://twitter.com/docusaurus" target="_blank" rel="noopener noreferrer" class="footer__link-item"><span>Twitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_3J9K"><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></span></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/threetwo-docs/blog">Blog</a></li><li class="footer__item"><a href="https://github.com/facebook/docusaurus" target="_blank" rel="noopener noreferrer" class="footer__link-item"><span>GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_3J9K"><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></span></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2022 My Project, Inc. Built with Docusaurus.</div></div></div></footer></div>
<script src="/threetwo-docs/assets/js/runtime~main.6aa04b35.js"></script>
<script src="/threetwo-docs/assets/js/main.8fb66527.js"></script>
</body>
</html>