Compare commits
11 Commits
gh-pages
...
original-f
| Author | SHA1 | Date | |
|---|---|---|---|
| bb9474bf98 | |||
|
|
23b3033a94 | ||
| b927acad04 | |||
| 0ad5eeda71 | |||
| ebebc3d5b5 | |||
| 9506ee7054 | |||
| 7972542fa1 | |||
| 4b30e0724c | |||
| 0153ed4269 | |||
| dccf4daa19 | |||
| 66832f9222 |
2
.github/workflows/documentation.yml
vendored
2
.github/workflows/documentation.yml
vendored
@@ -39,7 +39,7 @@ jobs:
|
|||||||
- name: Release to GitHub Pages
|
- name: Release to GitHub Pages
|
||||||
env:
|
env:
|
||||||
USE_SSH: true
|
USE_SSH: true
|
||||||
GIT_USER: git
|
GIT_USER: rishighan
|
||||||
run: |
|
run: |
|
||||||
git config --global user.email "rishi.ghan@gmail.com"
|
git config --global user.email "rishi.ghan@gmail.com"
|
||||||
git config --global user.name "rishighan"
|
git config --global user.name "rishighan"
|
||||||
|
|||||||
33
docs/architecture.md
Normal file
33
docs/architecture.md
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
---
|
||||||
|
sidebar_position: 4
|
||||||
|
id: architecture
|
||||||
|
title: 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
|
||||||
|
|
||||||
12
docs/resources.md
Normal file
12
docs/resources.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
---
|
||||||
|
sidebar_position: 3
|
||||||
|
id: resources
|
||||||
|
title: Resources & Help
|
||||||
|
---
|
||||||
|
|
||||||
|
### Quick Links
|
||||||
|
|
||||||
|
- The source code for `ThreeTwo!` is located here: https://github.com/rishighan/threetwo
|
||||||
|
- The official `Discord` server is here: https://discord.gg/DbpcSNuM
|
||||||
|
- If you encounter problems, the best recourse to getting help is creating an issue on the repo, https://github.com/rishighan/threetwo/issues
|
||||||
|
- For other questions just pop them into the Discord channel
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
{
|
|
||||||
"label": "Tutorial - Basics",
|
|
||||||
"position": 2
|
|
||||||
}
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_position: 6
|
|
||||||
---
|
|
||||||
|
|
||||||
# Congratulations!
|
|
||||||
|
|
||||||
You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
|
|
||||||
|
|
||||||
Docusaurus has **much more to offer**!
|
|
||||||
|
|
||||||
Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**.
|
|
||||||
|
|
||||||
Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610)
|
|
||||||
|
|
||||||
## What's next?
|
|
||||||
|
|
||||||
- Read the [official documentation](https://docusaurus.io/).
|
|
||||||
- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout)
|
|
||||||
- Add a [search bar](https://docusaurus.io/docs/search)
|
|
||||||
- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase)
|
|
||||||
- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support)
|
|
||||||
@@ -1,34 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_position: 3
|
|
||||||
---
|
|
||||||
|
|
||||||
# Create a Blog Post
|
|
||||||
|
|
||||||
Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed...
|
|
||||||
|
|
||||||
## Create your first Post
|
|
||||||
|
|
||||||
Create a file at `blog/2021-02-28-greetings.md`:
|
|
||||||
|
|
||||||
```md title="blog/2021-02-28-greetings.md"
|
|
||||||
---
|
|
||||||
slug: greetings
|
|
||||||
title: Greetings!
|
|
||||||
authors:
|
|
||||||
- name: Joel Marcey
|
|
||||||
title: Co-creator of Docusaurus 1
|
|
||||||
url: https://github.com/JoelMarcey
|
|
||||||
image_url: https://github.com/JoelMarcey.png
|
|
||||||
- name: Sébastien Lorber
|
|
||||||
title: Docusaurus maintainer
|
|
||||||
url: https://sebastienlorber.com
|
|
||||||
image_url: https://github.com/slorber.png
|
|
||||||
tags: [greetings]
|
|
||||||
---
|
|
||||||
|
|
||||||
Congratulations, you have made your first post!
|
|
||||||
|
|
||||||
Feel free to play around and edit this post as much you like.
|
|
||||||
```
|
|
||||||
|
|
||||||
A new blog post is now available at `http://localhost:3000/blog/greetings`.
|
|
||||||
@@ -1,55 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_position: 2
|
|
||||||
---
|
|
||||||
|
|
||||||
# Create a Document
|
|
||||||
|
|
||||||
Documents are **groups of pages** connected through:
|
|
||||||
|
|
||||||
- a **sidebar**
|
|
||||||
- **previous/next navigation**
|
|
||||||
- **versioning**
|
|
||||||
|
|
||||||
## Create your first Doc
|
|
||||||
|
|
||||||
Create a markdown file at `docs/hello.md`:
|
|
||||||
|
|
||||||
```md title="docs/hello.md"
|
|
||||||
# Hello
|
|
||||||
|
|
||||||
This is my **first Docusaurus document**!
|
|
||||||
```
|
|
||||||
|
|
||||||
A new document is now available at `http://localhost:3000/docs/hello`.
|
|
||||||
|
|
||||||
## Configure the Sidebar
|
|
||||||
|
|
||||||
Docusaurus automatically **creates a sidebar** from the `docs` folder.
|
|
||||||
|
|
||||||
Add metadatas to customize the sidebar label and position:
|
|
||||||
|
|
||||||
```md title="docs/hello.md" {1-4}
|
|
||||||
---
|
|
||||||
sidebar_label: 'Hi!'
|
|
||||||
sidebar_position: 3
|
|
||||||
---
|
|
||||||
|
|
||||||
# Hello
|
|
||||||
|
|
||||||
This is my **first Docusaurus document**!
|
|
||||||
```
|
|
||||||
|
|
||||||
It is also possible to create your sidebar explicitly in `sidebars.js`:
|
|
||||||
|
|
||||||
```diff title="sidebars.js"
|
|
||||||
module.exports = {
|
|
||||||
tutorialSidebar: [
|
|
||||||
{
|
|
||||||
type: 'category',
|
|
||||||
label: 'Tutorial',
|
|
||||||
- items: [...],
|
|
||||||
+ items: ['hello'],
|
|
||||||
},
|
|
||||||
],
|
|
||||||
};
|
|
||||||
```
|
|
||||||
@@ -1,43 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_position: 1
|
|
||||||
---
|
|
||||||
|
|
||||||
# Create a Page
|
|
||||||
|
|
||||||
Add **Markdown or React** files to `src/pages` to create a **standalone page**:
|
|
||||||
|
|
||||||
- `src/pages/index.js` -> `localhost:3000/`
|
|
||||||
- `src/pages/foo.md` -> `localhost:3000/foo`
|
|
||||||
- `src/pages/foo/bar.js` -> `localhost:3000/foo/bar`
|
|
||||||
|
|
||||||
## Create your first React Page
|
|
||||||
|
|
||||||
Create a file at `src/pages/my-react-page.js`:
|
|
||||||
|
|
||||||
```jsx title="src/pages/my-react-page.js"
|
|
||||||
import React from 'react';
|
|
||||||
import Layout from '@theme/Layout';
|
|
||||||
|
|
||||||
export default function MyReactPage() {
|
|
||||||
return (
|
|
||||||
<Layout>
|
|
||||||
<h1>My React page</h1>
|
|
||||||
<p>This is a React page</p>
|
|
||||||
</Layout>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
A new page is now available at `http://localhost:3000/my-react-page`.
|
|
||||||
|
|
||||||
## Create your first Markdown Page
|
|
||||||
|
|
||||||
Create a file at `src/pages/my-markdown-page.md`:
|
|
||||||
|
|
||||||
```mdx title="src/pages/my-markdown-page.md"
|
|
||||||
# My Markdown page
|
|
||||||
|
|
||||||
This is a Markdown page
|
|
||||||
```
|
|
||||||
|
|
||||||
A new page is now available at `http://localhost:3000/my-markdown-page`.
|
|
||||||
@@ -1,31 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_position: 5
|
|
||||||
---
|
|
||||||
|
|
||||||
# Deploy your site
|
|
||||||
|
|
||||||
Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**).
|
|
||||||
|
|
||||||
It builds your site as simple **static HTML, JavaScript and CSS files**.
|
|
||||||
|
|
||||||
## Build your site
|
|
||||||
|
|
||||||
Build your site **for production**:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run build
|
|
||||||
```
|
|
||||||
|
|
||||||
The static files are generated in the `build` folder.
|
|
||||||
|
|
||||||
## Deploy your site
|
|
||||||
|
|
||||||
Test your production build locally:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run serve
|
|
||||||
```
|
|
||||||
|
|
||||||
The `build` folder is now served at `http://localhost:3000/`.
|
|
||||||
|
|
||||||
You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**).
|
|
||||||
@@ -1,144 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_position: 4
|
|
||||||
---
|
|
||||||
|
|
||||||
# Markdown Features
|
|
||||||
|
|
||||||
Docusaurus supports **[Markdown](https://daringfireball.net/projects/markdown/syntax)** and a few **additional features**.
|
|
||||||
|
|
||||||
## Front Matter
|
|
||||||
|
|
||||||
Markdown documents have metadata at the top called [Front Matter](https://jekyllrb.com/docs/front-matter/):
|
|
||||||
|
|
||||||
```text title="my-doc.md"
|
|
||||||
// highlight-start
|
|
||||||
---
|
|
||||||
id: my-doc-id
|
|
||||||
title: My document title
|
|
||||||
description: My document description
|
|
||||||
slug: /my-custom-url
|
|
||||||
---
|
|
||||||
// highlight-end
|
|
||||||
|
|
||||||
## Markdown heading
|
|
||||||
|
|
||||||
Markdown text with [links](./hello.md)
|
|
||||||
```
|
|
||||||
|
|
||||||
## Links
|
|
||||||
|
|
||||||
Regular Markdown links are supported, using url paths or relative file paths.
|
|
||||||
|
|
||||||
```md
|
|
||||||
Let's see how to [Create a page](/create-a-page).
|
|
||||||
```
|
|
||||||
|
|
||||||
```md
|
|
||||||
Let's see how to [Create a page](./create-a-page.md).
|
|
||||||
```
|
|
||||||
|
|
||||||
**Result:** Let's see how to [Create a page](./create-a-page.md).
|
|
||||||
|
|
||||||
## Images
|
|
||||||
|
|
||||||
Regular Markdown images are supported.
|
|
||||||
|
|
||||||
Add an image at `static/img/docusaurus.png` and display it in Markdown:
|
|
||||||
|
|
||||||
```md
|
|
||||||

|
|
||||||
```
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
## Code Blocks
|
|
||||||
|
|
||||||
Markdown code blocks are supported with Syntax highlighting.
|
|
||||||
|
|
||||||
```jsx title="src/components/HelloDocusaurus.js"
|
|
||||||
function HelloDocusaurus() {
|
|
||||||
return (
|
|
||||||
<h1>Hello, Docusaurus!</h1>
|
|
||||||
)
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
```jsx title="src/components/HelloDocusaurus.js"
|
|
||||||
function HelloDocusaurus() {
|
|
||||||
return <h1>Hello, Docusaurus!</h1>;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Admonitions
|
|
||||||
|
|
||||||
Docusaurus has a special syntax to create admonitions and callouts:
|
|
||||||
|
|
||||||
:::tip My tip
|
|
||||||
|
|
||||||
Use this awesome feature option
|
|
||||||
|
|
||||||
:::
|
|
||||||
|
|
||||||
:::danger Take care
|
|
||||||
|
|
||||||
This action is dangerous
|
|
||||||
|
|
||||||
:::
|
|
||||||
|
|
||||||
:::tip My tip
|
|
||||||
|
|
||||||
Use this awesome feature option
|
|
||||||
|
|
||||||
:::
|
|
||||||
|
|
||||||
:::danger Take care
|
|
||||||
|
|
||||||
This action is dangerous
|
|
||||||
|
|
||||||
:::
|
|
||||||
|
|
||||||
## MDX and React Components
|
|
||||||
|
|
||||||
[MDX](https://mdxjs.com/) can make your documentation more **interactive** and allows using any **React components inside Markdown**:
|
|
||||||
|
|
||||||
```jsx
|
|
||||||
export const Highlight = ({children, color}) => (
|
|
||||||
<span
|
|
||||||
style={{
|
|
||||||
backgroundColor: color,
|
|
||||||
borderRadius: '20px',
|
|
||||||
color: '#fff',
|
|
||||||
padding: '10px',
|
|
||||||
cursor: 'pointer',
|
|
||||||
}}
|
|
||||||
onClick={() => {
|
|
||||||
alert(`You clicked the color ${color} with label ${children}`)
|
|
||||||
}}>
|
|
||||||
{children}
|
|
||||||
</span>
|
|
||||||
);
|
|
||||||
|
|
||||||
This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !
|
|
||||||
|
|
||||||
This is <Highlight color="#1877F2">Facebook blue</Highlight> !
|
|
||||||
```
|
|
||||||
|
|
||||||
export const Highlight = ({children, color}) => (
|
|
||||||
<span
|
|
||||||
style={{
|
|
||||||
backgroundColor: color,
|
|
||||||
borderRadius: '20px',
|
|
||||||
color: '#fff',
|
|
||||||
padding: '10px',
|
|
||||||
cursor: 'pointer',
|
|
||||||
}}
|
|
||||||
onClick={() => {
|
|
||||||
alert(`You clicked the color ${color} with label ${children}`);
|
|
||||||
}}>
|
|
||||||
{children}
|
|
||||||
</span>
|
|
||||||
);
|
|
||||||
|
|
||||||
This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !
|
|
||||||
|
|
||||||
This is <Highlight color="#1877F2">Facebook blue</Highlight> !
|
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
{
|
|
||||||
"label": "Tutorial - Extras",
|
|
||||||
"position": 3
|
|
||||||
}
|
|
||||||
@@ -1,55 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_position: 1
|
|
||||||
---
|
|
||||||
|
|
||||||
# Manage Docs Versions
|
|
||||||
|
|
||||||
Docusaurus can manage multiple versions of your docs.
|
|
||||||
|
|
||||||
## Create a docs version
|
|
||||||
|
|
||||||
Release a version 1.0 of your project:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run docusaurus docs:version 1.0
|
|
||||||
```
|
|
||||||
|
|
||||||
The `docs` folder is copied into `versioned_docs/version-1.0` and `versions.json` is created.
|
|
||||||
|
|
||||||
Your docs now have 2 versions:
|
|
||||||
|
|
||||||
- `1.0` at `http://localhost:3000/docs/` for the version 1.0 docs
|
|
||||||
- `current` at `http://localhost:3000/docs/next/` for the **upcoming, unreleased docs**
|
|
||||||
|
|
||||||
## Add a Version Dropdown
|
|
||||||
|
|
||||||
To navigate seamlessly across versions, add a version dropdown.
|
|
||||||
|
|
||||||
Modify the `docusaurus.config.js` file:
|
|
||||||
|
|
||||||
```js title="docusaurus.config.js"
|
|
||||||
module.exports = {
|
|
||||||
themeConfig: {
|
|
||||||
navbar: {
|
|
||||||
items: [
|
|
||||||
// highlight-start
|
|
||||||
{
|
|
||||||
type: 'docsVersionDropdown',
|
|
||||||
},
|
|
||||||
// highlight-end
|
|
||||||
],
|
|
||||||
},
|
|
||||||
},
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
The docs version dropdown appears in your navbar:
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
## Update an existing version
|
|
||||||
|
|
||||||
It is possible to edit versioned docs in their respective folder:
|
|
||||||
|
|
||||||
- `versioned_docs/version-1.0/hello.md` updates `http://localhost:3000/docs/hello`
|
|
||||||
- `docs/hello.md` updates `http://localhost:3000/docs/next/hello`
|
|
||||||
@@ -1,88 +0,0 @@
|
|||||||
---
|
|
||||||
sidebar_position: 2
|
|
||||||
---
|
|
||||||
|
|
||||||
# Translate your site
|
|
||||||
|
|
||||||
Let's translate `docs/intro.md` to French.
|
|
||||||
|
|
||||||
## Configure i18n
|
|
||||||
|
|
||||||
Modify `docusaurus.config.js` to add support for the `fr` locale:
|
|
||||||
|
|
||||||
```js title="docusaurus.config.js"
|
|
||||||
module.exports = {
|
|
||||||
i18n: {
|
|
||||||
defaultLocale: 'en',
|
|
||||||
locales: ['en', 'fr'],
|
|
||||||
},
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Translate a doc
|
|
||||||
|
|
||||||
Copy the `docs/intro.md` file to the `i18n/fr` folder:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
mkdir -p i18n/fr/docusaurus-plugin-content-docs/current/
|
|
||||||
|
|
||||||
cp docs/intro.md i18n/fr/docusaurus-plugin-content-docs/current/intro.md
|
|
||||||
```
|
|
||||||
|
|
||||||
Translate `i18n/fr/docusaurus-plugin-content-docs/current/intro.md` in French.
|
|
||||||
|
|
||||||
## Start your localized site
|
|
||||||
|
|
||||||
Start your site on the French locale:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run start -- --locale fr
|
|
||||||
```
|
|
||||||
|
|
||||||
Your localized site is accessible at `http://localhost:3000/fr/` and the `Getting Started` page is translated.
|
|
||||||
|
|
||||||
:::caution
|
|
||||||
|
|
||||||
In development, you can only use one locale at a same time.
|
|
||||||
|
|
||||||
:::
|
|
||||||
|
|
||||||
## Add a Locale Dropdown
|
|
||||||
|
|
||||||
To navigate seamlessly across languages, add a locale dropdown.
|
|
||||||
|
|
||||||
Modify the `docusaurus.config.js` file:
|
|
||||||
|
|
||||||
```js title="docusaurus.config.js"
|
|
||||||
module.exports = {
|
|
||||||
themeConfig: {
|
|
||||||
navbar: {
|
|
||||||
items: [
|
|
||||||
// highlight-start
|
|
||||||
{
|
|
||||||
type: 'localeDropdown',
|
|
||||||
},
|
|
||||||
// highlight-end
|
|
||||||
],
|
|
||||||
},
|
|
||||||
},
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
The locale dropdown now appears in your navbar:
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
## Build your localized site
|
|
||||||
|
|
||||||
Build your site for a specific locale:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run build -- --locale fr
|
|
||||||
```
|
|
||||||
|
|
||||||
Or build your site to include all the locales at once:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run build
|
|
||||||
```
|
|
||||||
203
docs/unraid_dockercompose.md
Normal file
203
docs/unraid_dockercompose.md
Normal file
@@ -0,0 +1,203 @@
|
|||||||
|
---
|
||||||
|
sidebar_position: 2
|
||||||
|
id: unRAID_dockercompose
|
||||||
|
title: Install ThreeTwo! on unRAID with the docker-compose plugin
|
||||||
|
---
|
||||||
|
|
||||||
|
### Notes
|
||||||
|
|
||||||
|
This guide goes over ThreeTwo! installation on unRAID using the [docker-compose manager](https://forums.unRAID.net/topic/114415-plugin-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 associated with 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 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](https://airdcpp.net/download#linux-nas-docker-other)
|
||||||
|
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](https://comicvine.gamespot.com/api/). Metadata scraping will not work unless you supply an API key.
|
||||||
|
5. Open an unRAID terminal and create an `.env` file:
|
||||||
|
1. Run this command: `nano /boot/config/plugins/compose.manager/projects/ThreeTwo/.env`
|
||||||
|
2. Paste this into the file, replacing anything within `<>` with actual values:
|
||||||
|
```bash
|
||||||
|
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=true
|
||||||
|
LOGLEVEL=info
|
||||||
|
SERVICEDIR=dist/services
|
||||||
|
|
||||||
|
CHOKIDAR_USEPOLLING=true
|
||||||
|
|
||||||
|
UNRAR_BIN_PATH=/usr/bin/unrar
|
||||||
|
SEVENZ_BINARY_PATH=/usr/bin/7za
|
||||||
|
MONGO_URI=mongodb://db:27017/threetwo
|
||||||
|
ELASTICSEARCH_URI=http://elasticsearch:9200
|
||||||
|
REDIS_URI=redis://redis:6379
|
||||||
|
TRANSPORTER=redis://redis:6379
|
||||||
|
CACHER=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:
|
||||||
|
```yaml
|
||||||
|
version: "3.7"
|
||||||
|
|
||||||
|
x-userdata-volume: &userdata-volume
|
||||||
|
type: bind
|
||||||
|
source: ${USERDATA_DIRECTORY}
|
||||||
|
target: /userdata
|
||||||
|
|
||||||
|
x-comics-volume: &comics-volume
|
||||||
|
type: bind
|
||||||
|
source: ${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
|
||||||
|
|
||||||
|
metadata-service:
|
||||||
|
build:
|
||||||
|
context: https://github.com/rishighan/threetwo-metadata-service.git
|
||||||
|
image: frishi/threetwo-metadata-service
|
||||||
|
container_name: metadata-service
|
||||||
|
ports:
|
||||||
|
- "3080:3080"
|
||||||
|
environment:
|
||||||
|
SERVICES: api,comicvine
|
||||||
|
env_file: /boot/config/plugins/compose.manager/projects/ThreeTwo/.env
|
||||||
|
depends_on:
|
||||||
|
- redis
|
||||||
|
volumes:
|
||||||
|
- *comics-volume
|
||||||
|
- *userdata-volume
|
||||||
|
networks:
|
||||||
|
- proxy
|
||||||
|
|
||||||
|
core-services:
|
||||||
|
build:
|
||||||
|
context: https://github.com/rishighan/threetwo-core-service.git
|
||||||
|
image: frishi/threetwo-core-service
|
||||||
|
container_name: core-services
|
||||||
|
ports:
|
||||||
|
- "3000:3000"
|
||||||
|
- "3001:3001"
|
||||||
|
depends_on:
|
||||||
|
- db
|
||||||
|
- redis
|
||||||
|
- elasticsearch
|
||||||
|
environment:
|
||||||
|
name: core-services
|
||||||
|
SERVICES: api,library,importqueue,settings,search,socket,imagetransformation,opds
|
||||||
|
env_file: /boot/config/plugins/compose.manager/projects/ThreeTwo/.env
|
||||||
|
volumes:
|
||||||
|
- *comics-volume
|
||||||
|
- *userdata-volume
|
||||||
|
|
||||||
|
networks:
|
||||||
|
- proxy
|
||||||
|
|
||||||
|
db:
|
||||||
|
image: "bitnami/mongodb:latest"
|
||||||
|
container_name: database
|
||||||
|
networks:
|
||||||
|
- proxy
|
||||||
|
ports:
|
||||||
|
- "27017:27017"
|
||||||
|
volumes:
|
||||||
|
- "mongodb_data:/bitnami/mongodb"
|
||||||
|
|
||||||
|
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: local
|
||||||
|
elastic:
|
||||||
|
driver: local
|
||||||
|
```
|
||||||
|
|
||||||
|
5. Click `Save Changes`
|
||||||
|
6. Click `Compose Up` and check for 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
|
||||||
|
|
||||||
|
### Getting Updates
|
||||||
|
|
||||||
|
Go to the `Docker Containers` tab from the unRAID web UI:
|
||||||
|
|
||||||
|
1. Click on `Compose Down`, and let the command finish running.
|
||||||
|
2. Click on `Compose Pull`, and let it finish running.
|
||||||
|
3. Click on `Compose Up` to bring up the stack.
|
||||||
64
docs/unraid_install.md
Normal file
64
docs/unraid_install.md
Normal file
@@ -0,0 +1,64 @@
|
|||||||
|
---
|
||||||
|
sidebar_position: 2
|
||||||
|
id: unraid_install
|
||||||
|
title: 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](https://cdimage.debian.org/debian-cd/current/amd64/iso-cd/debian-11.1.0-amd64-netinst.iso))
|
||||||
|
|
||||||
|
### 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](https://unix.stackexchange.com/questions/354928/bash-sudo-command-not-found) `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](https://docs.docker.com/engine/install/debian/)
|
||||||
|
5. Install [docker-compose](https://docs.docker.com/compose/install/#install-compose-on-linux-systems)
|
||||||
|
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`
|
||||||
|
```bash
|
||||||
|
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`
|
||||||
|
2.
|
||||||
@@ -43,21 +43,21 @@ const config = {
|
|||||||
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
|
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
|
||||||
({
|
({
|
||||||
navbar: {
|
navbar: {
|
||||||
title: 'My Site',
|
title: 'ThreeTwo!',
|
||||||
logo: {
|
logo: {
|
||||||
alt: 'My Site Logo',
|
alt: 'My Site Logo',
|
||||||
src: 'img/logo.svg',
|
src: 'img/threetwo.png',
|
||||||
},
|
},
|
||||||
items: [
|
items: [
|
||||||
{
|
{
|
||||||
type: 'doc',
|
type: 'doc',
|
||||||
docId: 'intro',
|
docId: 'intro',
|
||||||
position: 'left',
|
position: 'left',
|
||||||
label: 'Tutorial',
|
label: 'Quick Start',
|
||||||
},
|
},
|
||||||
{to: '/blog', label: 'Blog', position: 'left'},
|
{to: '/blog', label: 'Blog', position: 'left'},
|
||||||
{
|
{
|
||||||
href: 'https://github.com/facebook/docusaurus',
|
href: 'https://github.com/rishighan/threetwo',
|
||||||
label: 'GitHub',
|
label: 'GitHub',
|
||||||
position: 'right',
|
position: 'right',
|
||||||
},
|
},
|
||||||
@@ -79,16 +79,12 @@ const config = {
|
|||||||
title: 'Community',
|
title: 'Community',
|
||||||
items: [
|
items: [
|
||||||
{
|
{
|
||||||
label: 'Stack Overflow',
|
label: 'Github',
|
||||||
href: 'https://stackoverflow.com/questions/tagged/docusaurus',
|
href: 'https://github.com/rishighan/threetwo',
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: 'Discord',
|
label: 'Discord',
|
||||||
href: 'https://discordapp.com/invite/docusaurus',
|
href: 'https://discord.gg/n4HZ4j33uT',
|
||||||
},
|
|
||||||
{
|
|
||||||
label: 'Twitter',
|
|
||||||
href: 'https://twitter.com/docusaurus',
|
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
@@ -100,13 +96,16 @@ const config = {
|
|||||||
to: '/blog',
|
to: '/blog',
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: 'GitHub',
|
label: 'Rishi Ghan',
|
||||||
href: 'https://github.com/facebook/docusaurus',
|
href: 'https://rishighan.com',
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
|
copyright: `Copyright © ${new Date().getFullYear()} Quasar Software, LLC. Built with Docusaurus.`,
|
||||||
|
},
|
||||||
|
colorMode: {
|
||||||
|
disableSwitch: true,
|
||||||
},
|
},
|
||||||
prism: {
|
prism: {
|
||||||
theme: lightCodeTheme,
|
theme: lightCodeTheme,
|
||||||
|
|||||||
@@ -15,8 +15,8 @@
|
|||||||
"typecheck": "tsc"
|
"typecheck": "tsc"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@docusaurus/core": "^2.0.0-beta.6",
|
"@docusaurus/core": "^2.1.0",
|
||||||
"@docusaurus/preset-classic": "^2.0.0-beta.6",
|
"@docusaurus/preset-classic": "^2.1.0",
|
||||||
"@mdx-js/react": "^1.6.21",
|
"@mdx-js/react": "^1.6.21",
|
||||||
"@svgr/webpack": "^5.5.0",
|
"@svgr/webpack": "^5.5.0",
|
||||||
"clsx": "^1.1.1",
|
"clsx": "^1.1.1",
|
||||||
@@ -27,7 +27,7 @@
|
|||||||
"url-loader": "^4.1.1"
|
"url-loader": "^4.1.1"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@docusaurus/module-type-aliases": "2.0.0-beta.6",
|
"@docusaurus/module-type-aliases": "^2.1.0",
|
||||||
"@tsconfig/docusaurus": "^1.0.4",
|
"@tsconfig/docusaurus": "^1.0.4",
|
||||||
"typescript": "^4.3.5"
|
"typescript": "^4.3.5"
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -6,6 +6,6 @@
|
|||||||
}
|
}
|
||||||
|
|
||||||
.featureSvg {
|
.featureSvg {
|
||||||
height: 200px;
|
min-height: 200px;
|
||||||
width: 200px;
|
min-width: 200px;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -16,32 +16,29 @@ type FeatureItem = {
|
|||||||
|
|
||||||
const FeatureList: FeatureItem[] = [
|
const FeatureList: FeatureItem[] = [
|
||||||
{
|
{
|
||||||
title: 'Easy to Use',
|
title: 'Don\'t Hate, Curate.',
|
||||||
image: '/img/undraw_docusaurus_mountain.svg',
|
image: './img/curate.svg',
|
||||||
description: (
|
description: (
|
||||||
<>
|
<>
|
||||||
Docusaurus was designed from the ground up to be easily installed and
|
Browse, search, discover your comic book library that you have so proudly built from scratch.
|
||||||
used to get your website up and running quickly.
|
|
||||||
</>
|
</>
|
||||||
),
|
),
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
title: 'Focus on What Matters',
|
title: 'No Fuss DC++',
|
||||||
image: '/img/undraw_docusaurus_tree.svg',
|
image: './img/dcpp.svg',
|
||||||
description: (
|
description: (
|
||||||
<>
|
<>
|
||||||
Docusaurus lets you focus on your docs, and we'll do the chores. Go
|
With first-class support for the excellent <code>AirDC++</code>, find and acquire hidden gems.
|
||||||
ahead and move your docs into the <code>docs</code> directory.
|
|
||||||
</>
|
</>
|
||||||
),
|
),
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
title: 'Powered by React',
|
title: 'Shine with Comic Vine',
|
||||||
image: '/img/undraw_docusaurus_react.svg',
|
image: './img/cv.svg',
|
||||||
description: (
|
description: (
|
||||||
<>
|
<>
|
||||||
Extend or customize your website layout by reusing React. Docusaurus can
|
Scrape Comic Vine's exhaustive comic book database to analyze and clean up your library's metadata.
|
||||||
be extended while reusing the same header and footer.
|
|
||||||
</>
|
</>
|
||||||
),
|
),
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ function HomepageHeader() {
|
|||||||
<Link
|
<Link
|
||||||
className="button button--secondary button--lg"
|
className="button button--secondary button--lg"
|
||||||
to="/docs/intro">
|
to="/docs/intro">
|
||||||
Docusaurus Tutorial - 5min ⏱️
|
Start Flipping!
|
||||||
</Link>
|
</Link>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
BIN
static/img/curate.png
Normal file
BIN
static/img/curate.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 274 KiB |
8
static/img/curate.svg
Normal file
8
static/img/curate.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 52 KiB |
8
static/img/cv.svg
Normal file
8
static/img/cv.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 72 KiB |
8
static/img/dcpp.svg
Normal file
8
static/img/dcpp.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 74 KiB |
BIN
static/img/threetwo.png
Normal file
BIN
static/img/threetwo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.1 KiB |
Reference in New Issue
Block a user