diff --git a/404.html b/404.html index fe1ae28..a6facd1 100644 --- a/404.html +++ b/404.html @@ -6,13 +6,13 @@ Page Not Found | ThreeTwo! - +
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

- + \ No newline at end of file diff --git a/assets/js/5946dff2.700b0943.js b/assets/js/5946dff2.700b0943.js new file mode 100644 index 0000000..2fdc728 --- /dev/null +++ b/assets/js/5946dff2.700b0943.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkthreetwo_docs=self.webpackChunkthreetwo_docs||[]).push([[813],{5001:function(e,n,t){t.r(n),t.d(n,{frontMatter:function(){return s},contentTitle:function(){return l},metadata:function(){return p},toc:function(){return c},default:function(){return d}});var o=t(7462),a=t(3366),i=(t(7294),t(3905)),r=["components"],s={sidebar_position:2,id:"unRAID_dockercompose",title:"Install ThreeTwo! on unRAID with the docker-compose plugin"},l=void 0,p={unversionedId:"unRAID_dockercompose",id:"unRAID_dockercompose",isDocsHomePage:!1,title:"Install ThreeTwo! on unRAID with the docker-compose plugin",description:"Notes",source:"@site/docs/unraid_dockercompose.md",sourceDirName:".",slug:"/unRAID_dockercompose",permalink:"/threetwo-docs/docs/unRAID_dockercompose",editUrl:"https://github.com/facebook/docusaurus/edit/main/website/docs/unraid_dockercompose.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{sidebar_position:2,id:"unRAID_dockercompose",title:"Install ThreeTwo! on unRAID with the docker-compose plugin"},sidebar:"tutorialSidebar",previous:{title:"Introduction",permalink:"/threetwo-docs/docs/intro"},next:{title:"Install ThreeTwo! on unRaid",permalink:"/threetwo-docs/docs/unraid_install"}},c=[{value:"Notes",id:"notes",children:[]},{value:"Pre-requisites",id:"pre-requisites",children:[]},{value:"Installation",id:"installation",children:[]},{value:"Ports",id:"ports",children:[]}],m={toc:c};function d(e){var n=e.components,t=(0,a.Z)(e,r);return(0,i.kt)("wrapper",(0,o.Z)({},m,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("h3",{id:"notes"},"Notes"),(0,i.kt)("p",null,"This guide goes over ThreeTwo! installation on unRAID using the ",(0,i.kt)("a",{parentName:"p",href:"https://forums.unRAID.net/topic/114415-plugin-docker-compose-manager/"},"docker-compose manager")," plugin. Currently, this is the recommended approach for unRAID users."),(0,i.kt)("p",null,"With the help of this plugin, you are able to pull the entire ThreeTwo! ",(0,i.kt)("inlineCode",{parentName:"p"},"docker-compose")," stack up, down with the click of a button. It abstracts away a lot of complexity of writing out commands in the console."),(0,i.kt)("p",null,"That said, the plugin is still in beta, so you may experience strange behavior. "),(0,i.kt)("h3",{id:"pre-requisites"},"Pre-requisites"),(0,i.kt)("p",null,"First things first, let's go over what the pre-requisites are:"),(0,i.kt)("ol",null,(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"The ",(0,i.kt)("inlineCode",{parentName:"p"},"docker-compose")," configuration for ThreeTwo! now resides in its own repo here: ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/rishighan/threetwo-docker-compose"},"https://github.com/rishighan/threetwo-docker-compose")," You will be using this as a reference.")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"A working ",(0,i.kt)("inlineCode",{parentName:"p"},"AirDC++")," install is necessary for ",(0,i.kt)("inlineCode",{parentName:"p"},"DC++")," searching/downloading to work. You can install it through the unRAID via the CA store or via a ",(0,i.kt)("a",{parentName:"p",href:"https://airdcpp.net/download#linux-nas-docker-other"},"docker"))),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("inlineCode",{parentName:"p"},"comics")," and ",(0,i.kt)("inlineCode",{parentName:"p"},"userdata")," folders."),(0,i.kt)("ol",{parentName:"li"},(0,i.kt)("li",{parentName:"ol"},"The ",(0,i.kt)("inlineCode",{parentName:"li"},"comics")," folder ",(0,i.kt)("em",{parentName:"li"},"must")," be the folder ",(0,i.kt)("inlineCode",{parentName:"li"},"AirDC++")," downloads comics to."),(0,i.kt)("li",{parentName:"ol"},"Create the ",(0,i.kt)("inlineCode",{parentName:"li"},"userdata")," folder under ",(0,i.kt)("inlineCode",{parentName:"li"},"/mnt/user/appdata/threetwo")))),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"To get ComicVine to work for metadata scraping and other functions, you ",(0,i.kt)("em",{parentName:"p"},"must")," have a ComicVine API key. You can get one here. Metadata scraping will not work unless you supply an API key.")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"Open an unRAID terminal and create an ",(0,i.kt)("inlineCode",{parentName:"p"},".env")," file:"),(0,i.kt)("ol",{parentName:"li"},(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("inlineCode",{parentName:"li"},"nano /boot/config/plugins/compose.manager/projects/ThreeTwo/.env")),(0,i.kt)("li",{parentName:"ol"},"Paste this into the file, replacing anything within ",(0,i.kt)("inlineCode",{parentName:"li"},"<>")," with actual values:")),(0,i.kt)("pre",{parentName:"li"},(0,i.kt)("code",{parentName:"pre",className:"language-bash"},"UNDERLYING_HOSTNAME=\nCOMICS_DIRECTORY=\nUSERDATA_DIRECTORY=/mnt/user/appdata/threetwo/userdata\n\nCOMICVINE_API_KEY=\n\nLOGGER=true\nLOGLEVEL=info\nSERVICEDIR=dist/services\n\nCHOKIDAR_USEPOLLING=true\n\nUNRAR_BIN_PATH=/usr/bin/unrar\nSEVENZ_BINARY_PATH=/usr/bin/7za\nMONGO_URI=mongodb://db:27017/threetwo\nELASTICSEARCH_URI=http://elasticsearch:9200\nREDIS_URI=redis://redis:6379\nTRANSPORTER=redis://redis:6379\nCACHER=Memory\n")))),(0,i.kt)("h3",{id:"installation"},"Installation"),(0,i.kt)("ol",null,(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"Install the ",(0,i.kt)("inlineCode",{parentName:"p"},"docker-compose manager")," plugin from the unRAID CA store. After installation, you can find the plugin UI under the ",(0,i.kt)("inlineCode",{parentName:"p"},"Docker")," tab.")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"Create a new stack, give it a name.")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"Hover over the gear next to it and click on ",(0,i.kt)("inlineCode",{parentName:"p"},"Edit Stack"),".")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"Copy-paste this into the textarea:"),(0,i.kt)("pre",{parentName:"li"},(0,i.kt)("code",{parentName:"pre",className:"language-yaml"},'version: "3.7"\n\nx-userdata-volume:\n&userdata-volume\ntype: bind\nsource: ${USERDATA_DIRECTORY}\ntarget: /userdata\n\nx-comics-volume:\n&comics-volume\ntype: bind\nsource: ${COMICS_DIRECTORY}\ntarget: /comics\n\nservices:\nthreetwo:\n build:\n context: https://github.com/rishighan/threetwo.git\n dockerfile: Dockerfile\n image: frishi/threetwo\n container_name: threetwo-ui\n env_file: /boot/config/plugins/compose.manager/projects/ThreeTwo/.env\n restart: unless-stopped\n ports:\n - "8050:8050"\n - "3050:3050"\n links:\n - core-services\n depends_on:\n - db\n - elasticsearch\n - redis\n networks:\n - proxy\n\nmetadata-service:\n build:\n context: https://github.com/rishighan/threetwo-metadata-service.git\n image: frishi/threetwo-metadata-service\n container_name: metadata-service\n ports:\n - "3080:3080"\n environment:\n SERVICES: api,comicvine\n env_file: /boot/config/plugins/compose.manager/projects/ThreeTwo/.env\n depends_on:\n - redis\n volumes:\n - *comics-volume\n - *userdata-volume\n networks:\n - proxy\n\ncore-services:\n build:\n context: https://github.com/rishighan/threetwo-core-service.git\n image: frishi/threetwo-core-service\n container_name: core-services\n ports:\n - "3000:3000"\n - "3001:3001"\n depends_on:\n - db\n - redis\n - elasticsearch\n environment:\n name: core-services\n SERVICES: api,library,importqueue,settings,search,socket,imagetransformation,opds\n env_file: /boot/config/plugins/compose.manager/projects/ThreeTwo/.env\n volumes:\n - *comics-volume\n - *userdata-volume\n\n networks:\n - proxy\n\ndb:\n image: "bitnami/mongodb:latest"\n container_name: database\n networks:\n - proxy\n ports:\n - "27017:27017"\n volumes:\n - "mongodb_data:/bitnami/mongodb"\n\nredis:\n image: "bitnami/redis:latest"\n container_name: queue\n environment:\n ALLOW_EMPTY_PASSWORD: "yes"\n networks:\n - proxy\n ports:\n - "6379:6379"\n\nelasticsearch:\n image: docker.elastic.co/elasticsearch/elasticsearch:7.16.2\n container_name: elasticsearch\n environment:\n - "discovery.type=single-node"\n - "ES_JAVA_OPTS=-Xms512m -Xmx512m"\n - "xpack.security.enabled=true"\n - "xpack.security.authc.api_key.enabled=true"\n - "ELASTIC_PASSWORD=password"\n ulimits:\n memlock:\n soft: -1\n hard: -1\n ports:\n - 9200:9200\n networks:\n - proxy\n\nnetworks:\nproxy:\n external: true\n\nvolumes:\nmongodb_data:\n driver: local\nelasticsearch:\n driver: local\n'))),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"Click ",(0,i.kt)("inlineCode",{parentName:"p"},"Save Changes"))),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"Click ",(0,i.kt)("inlineCode",{parentName:"p"},"Compose Up")," and observe for any errors.")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"If all goes well, you should see the following containers appear as icons without images in the unRAID ",(0,i.kt)("inlineCode",{parentName:"p"},"Docker Containers")," panel:"),(0,i.kt)("ol",{parentName:"li"},(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("inlineCode",{parentName:"li"},"threetwo-ui")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("inlineCode",{parentName:"li"},"core-services")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("inlineCode",{parentName:"li"},"metadata-service")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("inlineCode",{parentName:"li"},"elasticsearch")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("inlineCode",{parentName:"li"},"database")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("inlineCode",{parentName:"li"},"queue")))),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"You can look at the logs for these containers by clicking on their icons and then ",(0,i.kt)("inlineCode",{parentName:"p"},"Logs")))),(0,i.kt)("h3",{id:"ports"},"Ports"),(0,i.kt)("ol",null,(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("inlineCode",{parentName:"li"},"threetwo-ui"),", runs on port 8050"),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("inlineCode",{parentName:"li"},"threetwo-core-service")," on 3000"),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("inlineCode",{parentName:"li"},"threetwo-metadata-service")," on 3080")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5946dff2.83587e1a.js b/assets/js/5946dff2.83587e1a.js deleted file mode 100644 index 4862b35..0000000 --- a/assets/js/5946dff2.83587e1a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkthreetwo_docs=self.webpackChunkthreetwo_docs||[]).push([[813],{5001:function(e,n,t){t.r(n),t.d(n,{frontMatter:function(){return s},contentTitle:function(){return l},metadata:function(){return p},toc:function(){return c},default:function(){return d}});var o=t(7462),a=t(3366),i=(t(7294),t(3905)),r=["components"],s={sidebar_position:2,id:"unRAID_dockercompose",title:"Install ThreeTwo! on unRAID with the docker-compose plugin"},l=void 0,p={unversionedId:"unRAID_dockercompose",id:"unRAID_dockercompose",isDocsHomePage:!1,title:"Install ThreeTwo! on unRAID with the docker-compose plugin",description:"Notes:",source:"@site/docs/unraid_dockercompose.md",sourceDirName:".",slug:"/unRAID_dockercompose",permalink:"/threetwo-docs/docs/unRAID_dockercompose",editUrl:"https://github.com/facebook/docusaurus/edit/main/website/docs/unraid_dockercompose.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{sidebar_position:2,id:"unRAID_dockercompose",title:"Install ThreeTwo! on unRAID with the docker-compose plugin"},sidebar:"tutorialSidebar",previous:{title:"Introduction",permalink:"/threetwo-docs/docs/intro"},next:{title:"Install ThreeTwo! on unRaid",permalink:"/threetwo-docs/docs/unraid_install"}},c=[{value:"Notes:",id:"notes",children:[]},{value:"Pre-requisites:",id:"pre-requisites",children:[]},{value:"Installation:",id:"installation",children:[]},{value:"Ports",id:"ports",children:[]}],m={toc:c};function d(e){var n=e.components,t=(0,a.Z)(e,r);return(0,i.kt)("wrapper",(0,o.Z)({},m,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("h3",{id:"notes"},"Notes:"),(0,i.kt)("p",null,"This guide goes over ThreeTwo! installation on unRAID using the ",(0,i.kt)("a",{parentName:"p",href:"https://forums.unRAID.net/topic/114415-plugin-docker-compose-manager/"},"docker-compose manager")," plugin. Currently this is the recommended approach for unRAID users."),(0,i.kt)("p",null,"With the help of this plugin, you are able to pull the entire ThreeTwo! ",(0,i.kt)("inlineCode",{parentName:"p"},"docker-compose")," stack up, down with the click of a button. It abstracts away a lot of complexity of writing out commands in the console."),(0,i.kt)("p",null,"That said, the plugin is still in beta, so you may experience strange behavior. "),(0,i.kt)("h3",{id:"pre-requisites"},"Pre-requisites:"),(0,i.kt)("p",null,"First things first, let's go over what the pre-requisites are:"),(0,i.kt)("ol",null,(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"The ",(0,i.kt)("inlineCode",{parentName:"p"},"docker-compose")," configuration for ThreeTwo! now resides in its own repo here: ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/rishighan/threetwo-docker-compose"},"https://github.com/rishighan/threetwo-docker-compose")," You will be using this as a reference.")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"A working ",(0,i.kt)("inlineCode",{parentName:"p"},"AirDC++")," install is necessary for ",(0,i.kt)("inlineCode",{parentName:"p"},"DC++")," searching/downloading to work. You can install it through the unRAID via the CA store or via a ",(0,i.kt)("a",{parentName:"p",href:"https://airdcpp.net/download#linux-nas-docker-other"},"docker"))),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("inlineCode",{parentName:"p"},"comics")," and ",(0,i.kt)("inlineCode",{parentName:"p"},"userdata")," folders."),(0,i.kt)("ol",{parentName:"li"},(0,i.kt)("li",{parentName:"ol"},"The ",(0,i.kt)("inlineCode",{parentName:"li"},"comics")," folder ",(0,i.kt)("em",{parentName:"li"},"must")," be the folder ",(0,i.kt)("inlineCode",{parentName:"li"},"AirDC++")," downloads comics to."),(0,i.kt)("li",{parentName:"ol"},"Create the ",(0,i.kt)("inlineCode",{parentName:"li"},"userdata")," folder under ",(0,i.kt)("inlineCode",{parentName:"li"},"/mnt/user/appdata/threetwo")))),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"To get ComicVine to work for metadata scraping and other functions, you ",(0,i.kt)("em",{parentName:"p"},"must")," have a ComicVine API key. You can get one here. Metadata scraping will not work unless you supply an API key.")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"Open an unRAID terminal and create an ",(0,i.kt)("inlineCode",{parentName:"p"},".env")," file:"),(0,i.kt)("ol",{parentName:"li"},(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("inlineCode",{parentName:"li"},"nano /boot/config/plugins/compose.manager/projects/ThreeTwo/.env")),(0,i.kt)("li",{parentName:"ol"},"Paste this into the file, replacing anything within ",(0,i.kt)("inlineCode",{parentName:"li"},"<>")," with actual values:")),(0,i.kt)("pre",{parentName:"li"},(0,i.kt)("code",{parentName:"pre",className:"language-bash"},"UNDERLYING_HOSTNAME=\nCOMICS_DIRECTORY=\nUSERDATA_DIRECTORY=/mnt/user/appdata/threetwo/userdata\n\nCOMICVINE_API_KEY=\n\nLOGGER=true\nLOGLEVEL=info\nSERVICEDIR=dist/services\n\nCHOKIDAR_USEPOLLING=true\n\nUNRAR_BIN_PATH=/usr/bin/unrar\nSEVENZ_BINARY_PATH=/usr/bin/7za\nMONGO_URI=mongodb://db:27017/threetwo\nELASTICSEARCH_URI=http://elasticsearch:9200\nREDIS_URI=redis://redis:6379\nTRANSPORTER=redis://redis:6379\nCACHER=Memory\n")))),(0,i.kt)("h3",{id:"installation"},"Installation:"),(0,i.kt)("ol",null,(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"Install the ",(0,i.kt)("inlineCode",{parentName:"p"},"docker-compose manager")," plugin from the unRAID CA store. After installation, you can find the plugin UI under the ",(0,i.kt)("inlineCode",{parentName:"p"},"Docker")," tab.")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"Create a new stack, give it a name.")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"Hover over the gear next to it and click on ",(0,i.kt)("inlineCode",{parentName:"p"},"Edit Stack"),".")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"Copy-paste this into the textarea:"),(0,i.kt)("pre",{parentName:"li"},(0,i.kt)("code",{parentName:"pre",className:"language-yaml"},'version: "3.7"\n\nx-userdata-volume:\n&userdata-volume\ntype: bind\nsource: ${USERDATA_DIRECTORY}\ntarget: /userdata\n\nx-comics-volume:\n&comics-volume\ntype: bind\nsource: ${COMICS_DIRECTORY}\ntarget: /comics\n\nservices:\nthreetwo:\n build:\n context: https://github.com/rishighan/threetwo.git\n dockerfile: Dockerfile\n image: frishi/threetwo\n container_name: threetwo-ui\n env_file: /boot/config/plugins/compose.manager/projects/ThreeTwo/.env\n restart: unless-stopped\n ports:\n - "8050:8050"\n - "3050:3050"\n links:\n - core-services\n depends_on:\n - db\n - elasticsearch\n - redis\n networks:\n - proxy\n\nmetadata-service:\n build:\n context: https://github.com/rishighan/threetwo-metadata-service.git\n image: frishi/threetwo-metadata-service\n container_name: metadata-service\n ports:\n - "3080:3080"\n environment:\n SERVICES: api,comicvine\n env_file: /boot/config/plugins/compose.manager/projects/ThreeTwo/.env\n depends_on:\n - redis\n volumes:\n - *comics-volume\n - *userdata-volume\n networks:\n - proxy\n\ncore-services:\n build:\n context: https://github.com/rishighan/threetwo-core-service.git\n image: frishi/threetwo-core-service\n container_name: core-services\n ports:\n - "3000:3000"\n - "3001:3001"\n depends_on:\n - db\n - redis\n - elasticsearch\n environment:\n name: core-services\n SERVICES: api,library,importqueue,settings,search,socket,imagetransformation,opds\n env_file: /boot/config/plugins/compose.manager/projects/ThreeTwo/.env\n volumes:\n - *comics-volume\n - *userdata-volume\n\n networks:\n - proxy\n\ndb:\n image: "bitnami/mongodb:latest"\n container_name: database\n networks:\n - proxy\n ports:\n - "27017:27017"\n volumes:\n - "mongodb_data:/bitnami/mongodb"\n\nredis:\n image: "bitnami/redis:latest"\n container_name: queue\n environment:\n ALLOW_EMPTY_PASSWORD: "yes"\n networks:\n - proxy\n ports:\n - "6379:6379"\n\nelasticsearch:\n image: docker.elastic.co/elasticsearch/elasticsearch:7.16.2\n container_name: elasticsearch\n environment:\n - "discovery.type=single-node"\n - "ES_JAVA_OPTS=-Xms512m -Xmx512m"\n - "xpack.security.enabled=true"\n - "xpack.security.authc.api_key.enabled=true"\n - "ELASTIC_PASSWORD=password"\n ulimits:\n memlock:\n soft: -1\n hard: -1\n ports:\n - 9200:9200\n networks:\n - proxy\n\nnetworks:\nproxy:\n external: true\n\nvolumes:\nmongodb_data:\n driver: local\nelasticsearch:\n driver: local\n'))),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"Click ",(0,i.kt)("inlineCode",{parentName:"p"},"Save Changes"))),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"Click ",(0,i.kt)("inlineCode",{parentName:"p"},"Compose Up")," and observe for any errors.")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"If all goes well, you should see the following containers appear as icons without images in the unRAID ",(0,i.kt)("inlineCode",{parentName:"p"},"Docker Containers")," panel:"),(0,i.kt)("ol",{parentName:"li"},(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("inlineCode",{parentName:"li"},"threetwo-ui")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("inlineCode",{parentName:"li"},"core-services")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("inlineCode",{parentName:"li"},"metadata-service")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("inlineCode",{parentName:"li"},"elasticsearch")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("inlineCode",{parentName:"li"},"database")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("inlineCode",{parentName:"li"},"queue")))),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"You can look at the logs for these containers by clicking on their icons and then ",(0,i.kt)("inlineCode",{parentName:"p"},"Logs")))),(0,i.kt)("h3",{id:"ports"},"Ports"),(0,i.kt)("ol",null,(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("inlineCode",{parentName:"li"},"threetwo-ui"),", runs on port 8050"),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("inlineCode",{parentName:"li"},"threetwo-core-service")," on 3000"),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("inlineCode",{parentName:"li"},"threetwo-metadata-service")," on 3080")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.08548672.js b/assets/js/runtime~main.bcf87146.js similarity index 98% rename from assets/js/runtime~main.08548672.js rename to assets/js/runtime~main.bcf87146.js index 7b9718b..4179278 100644 --- a/assets/js/runtime~main.08548672.js +++ b/assets/js/runtime~main.bcf87146.js @@ -1 +1 @@ -!function(){"use strict";var e,t,n,r,o,c={},f={};function a(e){var t=f[e];if(void 0!==t)return t.exports;var n=f[e]={id:e,loaded:!1,exports:{}};return c[e].call(n.exports,n,n.exports,a),n.loaded=!0,n.exports}a.m=c,a.c=f,e=[],a.O=function(t,n,r,o){if(!n){var c=1/0;for(d=0;d=o)&&Object.keys(a.O).every((function(e){return a.O[e](n[u])}))?n.splice(u--,1):(f=!1,o0&&e[d-1][2]>o;d--)e[d]=e[d-1];e[d]=[n,r,o]},a.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return a.d(t,{a:t}),t},n=Object.getPrototypeOf?function(e){return Object.getPrototypeOf(e)}:function(e){return e.__proto__},a.t=function(e,r){if(1&r&&(e=this(e)),8&r)return e;if("object"==typeof e&&e){if(4&r&&e.__esModule)return e;if(16&r&&"function"==typeof e.then)return e}var o=Object.create(null);a.r(o);var c={};t=t||[null,n({}),n([]),n(n)];for(var f=2&r&&e;"object"==typeof f&&!~t.indexOf(f);f=n(f))Object.getOwnPropertyNames(f).forEach((function(t){c[t]=function(){return e[t]}}));return c.default=function(){return e},a.d(o,c),o},a.d=function(e,t){for(var n in t)a.o(t,n)&&!a.o(e,n)&&Object.defineProperty(e,n,{enumerable:!0,get:t[n]})},a.f={},a.e=function(e){return Promise.all(Object.keys(a.f).reduce((function(t,n){return a.f[n](e,t),t}),[]))},a.u=function(e){return"assets/js/"+({3:"925b3f96",13:"01a85c17",32:"86a5cf17",36:"73664a40",45:"c0db966c",53:"935f2afb",85:"1f391b9e",89:"a6aa9e1f",103:"ccc49370",115:"03f09ed3",121:"55960ee5",237:"1df93b7f",267:"59362658",362:"e273c56f",414:"393be207",458:"421237dd",514:"1be78505",535:"814f3328",590:"4bcc3c7c",592:"common",608:"9e4087bc",610:"6875c492",636:"f4f34a3a",642:"7661071f",671:"0e384e19",714:"09c8d506",751:"3720c009",787:"30b2e18d",798:"d92a3c43",813:"5946dff2",830:"c0248160",914:"d9f32620",918:"17896441",927:"5281b7a2",948:"8717b14a"}[e]||e)+"."+{3:"a8b0a9bf",13:"88824f9f",32:"da2218c8",36:"1c1f42bc",45:"b6c5a98f",53:"fe77b760",75:"e24d0ea2",85:"34fa7b3c",89:"642319b3",103:"2910b377",115:"86863888",121:"b2aa5457",237:"6b506719",267:"44b9b8a3",362:"48857720",414:"d974e613",458:"36c0926f",514:"7c5fe792",535:"95981da2",590:"6e211512",592:"07ec1e38",608:"27d8422e",610:"c9edb3a1",636:"6a18501b",642:"2d4d7957",671:"1042b6e2",714:"4fa546da",751:"116541d6",787:"17c82bf0",798:"bd841b64",813:"83587e1a",830:"ca1f2136",845:"f6a6a72b",914:"0304da02",918:"826347ab",927:"f90c5c20",948:"2a97f55d"}[e]+".js"},a.miniCssF=function(e){return"assets/css/styles.75c8dd84.css"},a.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),a.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},r={},o="threetwo-docs:",a.l=function(e,t,n,c){if(r[e])r[e].push(t);else{var f,u;if(void 0!==n)for(var i=document.getElementsByTagName("script"),d=0;d=o)&&Object.keys(a.O).every((function(e){return a.O[e](n[u])}))?n.splice(u--,1):(f=!1,o0&&e[d-1][2]>o;d--)e[d]=e[d-1];e[d]=[n,r,o]},a.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return a.d(t,{a:t}),t},n=Object.getPrototypeOf?function(e){return Object.getPrototypeOf(e)}:function(e){return e.__proto__},a.t=function(e,r){if(1&r&&(e=this(e)),8&r)return e;if("object"==typeof e&&e){if(4&r&&e.__esModule)return e;if(16&r&&"function"==typeof e.then)return e}var o=Object.create(null);a.r(o);var c={};t=t||[null,n({}),n([]),n(n)];for(var f=2&r&&e;"object"==typeof f&&!~t.indexOf(f);f=n(f))Object.getOwnPropertyNames(f).forEach((function(t){c[t]=function(){return e[t]}}));return c.default=function(){return e},a.d(o,c),o},a.d=function(e,t){for(var n in t)a.o(t,n)&&!a.o(e,n)&&Object.defineProperty(e,n,{enumerable:!0,get:t[n]})},a.f={},a.e=function(e){return Promise.all(Object.keys(a.f).reduce((function(t,n){return a.f[n](e,t),t}),[]))},a.u=function(e){return"assets/js/"+({3:"925b3f96",13:"01a85c17",32:"86a5cf17",36:"73664a40",45:"c0db966c",53:"935f2afb",85:"1f391b9e",89:"a6aa9e1f",103:"ccc49370",115:"03f09ed3",121:"55960ee5",237:"1df93b7f",267:"59362658",362:"e273c56f",414:"393be207",458:"421237dd",514:"1be78505",535:"814f3328",590:"4bcc3c7c",592:"common",608:"9e4087bc",610:"6875c492",636:"f4f34a3a",642:"7661071f",671:"0e384e19",714:"09c8d506",751:"3720c009",787:"30b2e18d",798:"d92a3c43",813:"5946dff2",830:"c0248160",914:"d9f32620",918:"17896441",927:"5281b7a2",948:"8717b14a"}[e]||e)+"."+{3:"a8b0a9bf",13:"88824f9f",32:"da2218c8",36:"1c1f42bc",45:"b6c5a98f",53:"fe77b760",75:"e24d0ea2",85:"34fa7b3c",89:"642319b3",103:"2910b377",115:"86863888",121:"b2aa5457",237:"6b506719",267:"44b9b8a3",362:"48857720",414:"d974e613",458:"36c0926f",514:"7c5fe792",535:"95981da2",590:"6e211512",592:"07ec1e38",608:"27d8422e",610:"c9edb3a1",636:"6a18501b",642:"2d4d7957",671:"1042b6e2",714:"4fa546da",751:"116541d6",787:"17c82bf0",798:"bd841b64",813:"700b0943",830:"ca1f2136",845:"f6a6a72b",914:"0304da02",918:"826347ab",927:"f90c5c20",948:"2a97f55d"}[e]+".js"},a.miniCssF=function(e){return"assets/css/styles.75c8dd84.css"},a.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),a.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},r={},o="threetwo-docs:",a.l=function(e,t,n,c){if(r[e])r[e].push(t);else{var f,u;if(void 0!==n)for(var i=document.getElementsByTagName("script"),d=0;d Archive | ThreeTwo! - +

Archive

Archive

2019

2021

- + \ No newline at end of file diff --git a/blog/first-blog-post/index.html b/blog/first-blog-post/index.html index 2f4cab2..f47fa57 100644 --- a/blog/first-blog-post/index.html +++ b/blog/first-blog-post/index.html @@ -6,13 +6,13 @@ First Blog Post | ThreeTwo! - +

First Blog Post

· One min read
Gao Wei

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

- + \ No newline at end of file diff --git a/blog/index.html b/blog/index.html index 6ce2170..ace2d72 100644 --- a/blog/index.html +++ b/blog/index.html @@ -6,13 +6,13 @@ Blog | ThreeTwo! - +

· One min read
Sébastien Lorber
Yangshun Tay

Docusaurus blogging features are powered by the blog plugin.

Simply add Markdown files (or folders) to the blog directory.

Regular blog authors can be added to authors.yml.

The blog post date can be extracted from filenames, such as:

  • 2019-05-30-welcome.md
  • 2019-05-30-welcome/index.md

A blog post folder can be convenient to co-locate blog post images:

Docusaurus Plushie

The blog supports tags as well!

And if you don't want a blog: just delete this directory, and use blog: false in your Docusaurus config.

· One min read
Gao Wei

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

- + \ No newline at end of file diff --git a/blog/long-blog-post/index.html b/blog/long-blog-post/index.html index 547d460..b120a09 100644 --- a/blog/long-blog-post/index.html +++ b/blog/long-blog-post/index.html @@ -6,13 +6,13 @@ Long Blog Post | ThreeTwo! - +

Long Blog Post

· 3 min read
Endilie Yacop Sucipto

This is the summary of a very long blog post,

Use a <!-- truncate --> comment to limit blog post size in the list view.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

- + \ No newline at end of file diff --git a/blog/mdx-blog-post/index.html b/blog/mdx-blog-post/index.html index a559b84..9693af7 100644 --- a/blog/mdx-blog-post/index.html +++ b/blog/mdx-blog-post/index.html @@ -6,13 +6,13 @@ MDX Blog Post | ThreeTwo! - +
- + \ No newline at end of file diff --git a/blog/tags/docusaurus/index.html b/blog/tags/docusaurus/index.html index 9616752..7b21cf2 100644 --- a/blog/tags/docusaurus/index.html +++ b/blog/tags/docusaurus/index.html @@ -6,13 +6,13 @@ 4 posts tagged with "docusaurus" | ThreeTwo! - +

4 posts tagged with "docusaurus"

View All Tags

· One min read
Sébastien Lorber
Yangshun Tay

Docusaurus blogging features are powered by the blog plugin.

Simply add Markdown files (or folders) to the blog directory.

Regular blog authors can be added to authors.yml.

The blog post date can be extracted from filenames, such as:

  • 2019-05-30-welcome.md
  • 2019-05-30-welcome/index.md

A blog post folder can be convenient to co-locate blog post images:

Docusaurus Plushie

The blog supports tags as well!

And if you don't want a blog: just delete this directory, and use blog: false in your Docusaurus config.

· One min read
Gao Wei

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

- + \ No newline at end of file diff --git a/blog/tags/facebook/index.html b/blog/tags/facebook/index.html index 51aa449..3fa09ea 100644 --- a/blog/tags/facebook/index.html +++ b/blog/tags/facebook/index.html @@ -6,13 +6,13 @@ One post tagged with "facebook" | ThreeTwo! - +

One post tagged with "facebook"

View All Tags

· One min read
Sébastien Lorber
Yangshun Tay

Docusaurus blogging features are powered by the blog plugin.

Simply add Markdown files (or folders) to the blog directory.

Regular blog authors can be added to authors.yml.

The blog post date can be extracted from filenames, such as:

  • 2019-05-30-welcome.md
  • 2019-05-30-welcome/index.md

A blog post folder can be convenient to co-locate blog post images:

Docusaurus Plushie

The blog supports tags as well!

And if you don't want a blog: just delete this directory, and use blog: false in your Docusaurus config.

- + \ No newline at end of file diff --git a/blog/tags/hello/index.html b/blog/tags/hello/index.html index d2d15b7..4cc3a24 100644 --- a/blog/tags/hello/index.html +++ b/blog/tags/hello/index.html @@ -6,13 +6,13 @@ 2 posts tagged with "hello" | ThreeTwo! - +

2 posts tagged with "hello"

View All Tags

· One min read
Sébastien Lorber
Yangshun Tay

Docusaurus blogging features are powered by the blog plugin.

Simply add Markdown files (or folders) to the blog directory.

Regular blog authors can be added to authors.yml.

The blog post date can be extracted from filenames, such as:

  • 2019-05-30-welcome.md
  • 2019-05-30-welcome/index.md

A blog post folder can be convenient to co-locate blog post images:

Docusaurus Plushie

The blog supports tags as well!

And if you don't want a blog: just delete this directory, and use blog: false in your Docusaurus config.

- + \ No newline at end of file diff --git a/blog/tags/hola/index.html b/blog/tags/hola/index.html index 527d42d..813b78f 100644 --- a/blog/tags/hola/index.html +++ b/blog/tags/hola/index.html @@ -6,13 +6,13 @@ One post tagged with "hola" | ThreeTwo! - +

One post tagged with "hola"

View All Tags

· One min read
Gao Wei

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

- + \ No newline at end of file diff --git a/blog/tags/index.html b/blog/tags/index.html index 427230e..e55374f 100644 --- a/blog/tags/index.html +++ b/blog/tags/index.html @@ -6,13 +6,13 @@ Tags | ThreeTwo! - +

Tags

- + \ No newline at end of file diff --git a/blog/welcome/index.html b/blog/welcome/index.html index a06b51e..0a33f87 100644 --- a/blog/welcome/index.html +++ b/blog/welcome/index.html @@ -6,13 +6,13 @@ Welcome | ThreeTwo! - +

Welcome

· One min read
Sébastien Lorber
Yangshun Tay

Docusaurus blogging features are powered by the blog plugin.

Simply add Markdown files (or folders) to the blog directory.

Regular blog authors can be added to authors.yml.

The blog post date can be extracted from filenames, such as:

  • 2019-05-30-welcome.md
  • 2019-05-30-welcome/index.md

A blog post folder can be convenient to co-locate blog post images:

Docusaurus Plushie

The blog supports tags as well!

And if you don't want a blog: just delete this directory, and use blog: false in your Docusaurus config.

- + \ No newline at end of file diff --git a/docs/architecture/index.html b/docs/architecture/index.html index 856d30e..443cbb5 100644 --- a/docs/architecture/index.html +++ b/docs/architecture/index.html @@ -6,13 +6,13 @@ Technical Architecture | ThreeTwo! - +

Technical Architecture

High-level Architecture#

ThreeTwo!, the app is built upon the microservice architecture. The UI is a standalone node.js app and the rest of the logic is broken into microservices.

The microservices deal with:

  1. Library functions (model orchestration, CRUD ops on comics, metadata)
  2. Comic Vine (scraping issues, volumes and more)
  3. Grand Comics Database (scraping, aggregations and more)
  4. Helpers (image transformation, file-system ops, compression/uncompression)

Technical stack#

ThreeTwo! is written in TypeScript from UI to the services layer.

The technologies used are:

  1. React
  2. Redux
  3. moleculer
  4. RabbitMQ
  5. socket.io
  6. node.js
  7. Express
  8. MongoDB
  9. mongoose
- + \ No newline at end of file diff --git a/docs/intro/index.html b/docs/intro/index.html index b9d4838..4afc600 100644 --- a/docs/intro/index.html +++ b/docs/intro/index.html @@ -6,13 +6,13 @@ Introduction | ThreeTwo! - +

ThreeTwo!

ThreeTwo! is a comic book curation app.

It aims to help you organize your comic book collection and automate various aspects of acquiring new comic books.

It is a culmination of ideas I developed over the past couple of years using various pieces of software to achieve the stated goal of curating comic books. It borrows heavily from Mylar, Ubooquity, ComicRack, Calibre and many other software used to manage comic book collections.

Philosophy#

Curation is a disease of the mind, albeit a disease with a purpose. You want to be able to peruse your collection, and enjoy the process of doing so.

Discovery#

The first tenet of ThreeTwo! is discovery–the act of importing comics from your OS, finding new comic to read or just searching through your collection for a comic that sparks nostalgia. Discovery is important, both from a technical perspective, so that ThreeTwo! can infer metadata from your collection, as well as from a curatorial standpoint, you want to keep track of what you are reading, or what you want to be reading.

Curation#

ThreeTwo! takes curation seriously, and thusly offers ComicVine scraping, and other means of applying/extending the comic metadata. This is so that your collection can truly shine, and actually help in discovering or rediscovering comics.

Acquisition#

Once you have added to your list of wanted comics, you can rely on ThreeTwo!'s first-class support for DC++ via AirDC++ to acquire them. Just configure your AirDC++ host, hub information and you are golden.

Consumption#

You can access your massive comic collection via OPDS through apps on your mobile devices, like Panels on iOS

- + \ No newline at end of file diff --git a/docs/resources/index.html b/docs/resources/index.html index 325f435..839f65a 100644 --- a/docs/resources/index.html +++ b/docs/resources/index.html @@ -6,13 +6,13 @@ Resources & Help | ThreeTwo! - +
- + \ No newline at end of file diff --git a/docs/tags/index.html b/docs/tags/index.html index ce9f0a0..ec19219 100644 --- a/docs/tags/index.html +++ b/docs/tags/index.html @@ -6,13 +6,13 @@ Tags | ThreeTwo! - +

Tags

- + \ No newline at end of file diff --git a/docs/unRAID_dockercompose/index.html b/docs/unRAID_dockercompose/index.html index 85f17e9..8453107 100644 --- a/docs/unRAID_dockercompose/index.html +++ b/docs/unRAID_dockercompose/index.html @@ -5,17 +5,17 @@ -Install ThreeTwo! on unRAID with the docker-compose plugin | ThreeTwo! - +Install ThreeTwo! on unRAID with the docker-compose plugin | ThreeTwo! +
-

Install ThreeTwo! on unRAID with the docker-compose plugin

Notes:#

This guide goes over ThreeTwo! installation on unRAID using the docker-compose manager plugin. Currently this is the recommended approach for unRAID users.

With the help of this plugin, you are able to pull the entire ThreeTwo! docker-compose stack up, down with the click of a button. It abstracts away a lot of complexity of writing out commands in the console.

That said, the plugin is still in beta, so you may experience strange behavior.

Pre-requisites:#

First things first, let's go over what the pre-requisites are:

  1. The docker-compose configuration for ThreeTwo! now resides in its own repo here: https://github.com/rishighan/threetwo-docker-compose You will be using this as a reference.

  2. A working AirDC++ install is necessary for DC++ searching/downloading to work. You can install it through the unRAID via the CA store or via a docker

  3. comics and userdata folders.

    1. The comics folder must be the folder AirDC++ downloads comics to.
    2. Create the userdata folder under /mnt/user/appdata/threetwo

  4. To get ComicVine to work for metadata scraping and other functions, you must have a ComicVine API key. You can get one here. Metadata scraping will not work unless you supply an API key.

  5. Open an unRAID terminal and create an .env file:

    1. nano /boot/config/plugins/compose.manager/projects/ThreeTwo/.env
    2. Paste this into the file, replacing anything within <> with actual values:
    UNDERLYING_HOSTNAME=<UNRAID_HOSTNAME>COMICS_DIRECTORY=<PATH_TO_COMICS_DIRECTORY>USERDATA_DIRECTORY=/mnt/user/appdata/threetwo/userdata
+
    Install ThreeTwo! on unRAID with the docker-compose plugin
    Notes#
    This guide goes over ThreeTwo! installation on unRAID using the docker-compose manager plugin. Currently, this is the recommended approach for unRAID users.
    With the help of this plugin, you are able to pull the entire ThreeTwo! docker-compose stack up, down with the click of a button. It abstracts away a lot of complexity of writing out commands in the console.
    That said, the plugin is still in beta, so you may experience strange behavior.  
    Pre-requisites#
    First things first, let's go over what the pre-requisites are:
    1. The docker-compose configuration for ThreeTwo! now resides in its own repo here: https://github.com/rishighan/threetwo-docker-compose You will be using this as a reference.
    2. A working AirDC++ install is necessary for DC++ searching/downloading to work. You can install it through the unRAID via the CA store or via a docker
    3. comics and userdata folders.
      1. The comics folder must be the folder AirDC++ downloads comics to.
      2. Create the userdata folder under /mnt/user/appdata/threetwo
    4. To get ComicVine to work for metadata scraping and other functions, you must have a ComicVine API key. You can get one here. Metadata scraping will not work unless you supply an API key.
    5. Open an unRAID terminal and create an .env file:
      1. nano /boot/config/plugins/compose.manager/projects/ThreeTwo/.env
      2. Paste this into the file, replacing anything within <> with actual values:
      UNDERLYING_HOSTNAME=<UNRAID_HOSTNAME>COMICS_DIRECTORY=<PATH_TO_COMICS_DIRECTORY>USERDATA_DIRECTORY=/mnt/user/appdata/threetwo/userdata
 COMICVINE_API_KEY=<YOUR_COMICVINE_API_KEY>
 LOGGER=trueLOGLEVEL=infoSERVICEDIR=dist/services
 CHOKIDAR_USEPOLLING=true
-UNRAR_BIN_PATH=/usr/bin/unrarSEVENZ_BINARY_PATH=/usr/bin/7zaMONGO_URI=mongodb://db:27017/threetwoELASTICSEARCH_URI=http://elasticsearch:9200REDIS_URI=redis://redis:6379TRANSPORTER=redis://redis:6379CACHER=Memory
    Installation:#
    1. Install the docker-compose manager plugin from the unRAID CA store. After installation, you can find the plugin UI under the Docker tab.
    2. Create a new stack, give it a name.
    3. Hover over the gear next to it and click on Edit Stack.
    4. Copy-paste this into the textarea:
      version: "3.7"
+UNRAR_BIN_PATH=/usr/bin/unrarSEVENZ_BINARY_PATH=/usr/bin/7zaMONGO_URI=mongodb://db:27017/threetwoELASTICSEARCH_URI=http://elasticsearch:9200REDIS_URI=redis://redis:6379TRANSPORTER=redis://redis:6379CACHER=Memory
    Installation#
    1. Install the docker-compose manager plugin from the unRAID CA store. After installation, you can find the plugin UI under the Docker tab.
    2. Create a new stack, give it a name.
    3. Hover over the gear next to it and click on Edit Stack.
    4. Copy-paste this into the textarea:
      version: "3.7"
 x-userdata-volume:&userdata-volumetype: bindsource: ${USERDATA_DIRECTORY}target: /userdata
 x-comics-volume:&comics-volumetype: bindsource: ${COMICS_DIRECTORY}target: /comics
 services:threetwo:   build:      context: https://github.com/rishighan/threetwo.git      dockerfile: Dockerfile   image: frishi/threetwo   container_name: threetwo-ui   env_file: /boot/config/plugins/compose.manager/projects/ThreeTwo/.env   restart: unless-stopped   ports:      - "8050:8050"      - "3050:3050"   links:      - core-services   depends_on:      - db      - elasticsearch      - redis   networks:      - proxy
@@ -26,8 +26,8 @@
 redis:   image: "bitnami/redis:latest"   container_name: queue   environment:      ALLOW_EMPTY_PASSWORD: "yes"   networks:      - proxy   ports:      - "6379:6379"
 elasticsearch:   image: docker.elastic.co/elasticsearch/elasticsearch:7.16.2   container_name: elasticsearch   environment:      - "discovery.type=single-node"      - "ES_JAVA_OPTS=-Xms512m -Xmx512m"      - "xpack.security.enabled=true"      - "xpack.security.authc.api_key.enabled=true"      - "ELASTIC_PASSWORD=password"   ulimits:      memlock:      soft: -1      hard: -1   ports:      - 9200:9200   networks:      - proxy
 networks:proxy:   external: true
-volumes:mongodb_data:   driver: localelasticsearch:   driver: local
    5. Click Save Changes
    6. Click Compose Up and observe for any errors.
    7. If all goes well, you should see the following containers appear as icons without images in the unRAID Docker Containers panel:
      1. threetwo-ui
      2. core-services
      3. metadata-service
      4. elasticsearch
      5. database
      6. queue
    8. You can look at the logs for these containers by clicking on their icons and then Logs
    Ports#
    1. threetwo-ui, runs on port 8050
    2. threetwo-core-service on 3000
    3. threetwo-metadata-service on 3080
    - +volumes:mongodb_data: driver: localelasticsearch: driver: local

  • Click Save Changes

  • Click Compose Up and observe for any errors.

  • If all goes well, you should see the following containers appear as icons without images in the unRAID Docker Containers panel:

    1. threetwo-ui
    2. core-services
    3. metadata-service
    4. elasticsearch
    5. database
    6. queue

  • You can look at the logs for these containers by clicking on their icons and then Logs

    • Ports#

    1. threetwo-ui, runs on port 8050
    2. threetwo-core-service on 3000
    3. threetwo-metadata-service on 3080
    + \ No newline at end of file diff --git a/docs/unraid_install/index.html b/docs/unraid_install/index.html index 9f1cadb..eeaa12c 100644 --- a/docs/unraid_install/index.html +++ b/docs/unraid_install/index.html @@ -6,14 +6,14 @@ Install ThreeTwo! on unRaid | ThreeTwo! - +

    Install ThreeTwo! on unRaid

    Notes#

    • Currently, ThreeTwo! is installed along with its dependencies using docker-compose. The easiest way to install it on unRAID is to use a VM.
    • Skip the VM creation steps, if you already have a Debian VM

    Pre-requisites#

    This guide assumes the following is installed or readily available:

    • unRaid 6.9.2 (this version was tested against 6.9.2)
    • Debian 10.x (Grab the install .iso here)

    Getting the VM up and running#

    1. Download the Debian install .iso
    2. Place it in a folder accessible by the VM
    3. Go to the VM tab in your unRaid navigation
    4. Click Add VM
    5. From the list presented to you, click Debian under Linux
    6. On the VM configration page, enter the desired options for memory, CPU cores, vdisk allocation
    7. Make sure that you have set the volume containing the comics correctly for Unraid Share
    8. Make sure that you have also set the Unraid Mount tag option
    9. Make sure that the network bridge is set to br0
    10. Set a password for VNC so you can follow through with a graphical install if you so wish

    Installing Debian on the VM#

    1. Launch the VM via VNC Remote option
    2. Follow the steps of the graphical installer
    3. Create a root user and a normal user and set the passwords for both

    Docker pre-requisites#

    1. Make sure you have sudo
    2. Make sure you have ssh access for the user you created earlier
    3. ssh into the VM as the non-root user
    4. Install Docker Engine
    5. Install docker-compose
    6. Verify that docker and docker-compose commands work

    Installation#

    1. Clone the repo: git clone https://github.com/rishighan/threetwo.git

    2. Change the directory: cd threetwo

    3. Create directories within threetwo

      mkdir comics userdata
 mkdir userdata/covers userdata/temporary userdata/expanded

    4. Create an external docker network using sudo docker network create proxy

    5. Run sudo docker-compose up --build -d

    6. Wait for a hot minute

    Post-install checks#

    1. Once the docker-compose up command successfully completes, you can check the spun-up containers using docker ps
    - + \ No newline at end of file diff --git a/index.html b/index.html index c2f2620..0deb5f1 100644 --- a/index.html +++ b/index.html @@ -6,13 +6,13 @@ Hello from ThreeTwo! | ThreeTwo! - +

    ThreeTwo!

    Start Flipping!

    Start Flipping!
    Don't Hate, Curate.

    Don't Hate, Curate.

    Browse, search, discover your comic book library that you have so proudly built from scratch.

    No Fuss DC++

    No Fuss DC++

    With first-class support for the excellent AirDC++, find and acquire hidden gems.

    Shine with Comic Vine

    Shine with Comic Vine

    Scrape Comic Vine's exhaustive comic book database to analyze and clean up your library's metadata.

    - + \ No newline at end of file diff --git a/markdown-page/index.html b/markdown-page/index.html index 87b8d72..6fe3188 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -6,13 +6,13 @@ Markdown page example | ThreeTwo! - +

    Markdown page example

    You don't need React to write simple standalone pages.

    - + \ No newline at end of file