Skip to content

Commit 5c5cf02

Browse files
ludviglundgrenludviglundgren
committed
chore: initial commit
0 parents  commit 5c5cf02

39 files changed

+9086
-0
lines changed

‎.gitignore

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

‎README.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Website
2+
3+
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
4+
5+
### Installation
6+
7+
```
8+
$ yarn
9+
```
10+
11+
### Local Development
12+
13+
```
14+
$ yarn start
15+
```
16+
17+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18+
19+
### Build
20+
21+
```
22+
$ yarn build
23+
```
24+
25+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26+
27+
### Deployment
28+
29+
Using SSH:
30+
31+
```
32+
$ USE_SSH=true yarn deploy
33+
```
34+
35+
Not using SSH:
36+
37+
```
38+
$ GIT_USER=<Your GitHub username> yarn deploy
39+
```
40+
41+
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

‎babel.config.js

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
3+
};

‎blog/2019-05-28-first-blog-post.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
slug: first-blog-post
3+
title: First Blog Post
4+
authors:
5+
name: Gao Wei
6+
title: Docusaurus Core Team
7+
url: https://github.com/wgao19
8+
image_url: https://github.com/wgao19.png
9+
tags: [hola, docusaurus]
10+
---
11+
12+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

‎blog/2019-05-29-long-blog-post.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
slug: long-blog-post
3+
title: Long Blog Post
4+
authors: endi
5+
tags: [hello, docusaurus]
6+
---
7+
8+
This is the summary of a very long blog post,
9+
10+
Use a `<!--` `truncate` `-->` comment to limit blog post size in the list view.
11+
12+
<!--truncate-->
13+
14+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
15+
16+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
17+
18+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
19+
20+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
21+
22+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
23+
24+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
25+
26+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
27+
28+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
29+
30+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
31+
32+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
33+
34+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
35+
36+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
37+
38+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
39+
40+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
41+
42+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
43+
44+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

‎blog/2021-08-01-mdx-blog-post.mdx

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
slug: mdx-blog-post
3+
title: MDX Blog Post
4+
authors: [slorber]
5+
tags: [docusaurus]
6+
---
7+
8+
Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/).
9+
10+
:::tip
11+
12+
Use the power of React to create interactive blog posts.
13+
14+
```js
15+
<button onClick={() => alert('button clicked!')}>Click me!</button>
16+
```
17+
18+
<button onClick={() => alert('button clicked!')}>Click me!</button>
19+
20+
:::

‎blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg

93.9 KB
Loading

‎blog/2021-08-26-welcome/index.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
slug: welcome
3+
title: Welcome
4+
authors: [slorber, yangshun]
5+
tags: [facebook, hello, docusaurus]
6+
---
7+
8+
[Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).
9+
10+
Simply add Markdown files (or folders) to the `blog` directory.
11+
12+
Regular blog authors can be added to `authors.yml`.
13+
14+
The blog post date can be extracted from filenames, such as:
15+
16+
- `2019-05-30-welcome.md`
17+
- `2019-05-30-welcome/index.md`
18+
19+
A blog post folder can be convenient to co-locate blog post images:
20+
21+
![Docusaurus Plushie](./docusaurus-plushie-banner.jpeg)
22+
23+
The blog supports tags as well!
24+
25+
**And if you don't want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config.

‎blog/authors.yml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
endi:
2+
name: Endilie Yacop Sucipto
3+
title: Maintainer of Docusaurus
4+
url: https://github.com/endiliey
5+
image_url: https://github.com/endiliey.png
6+
7+
yangshun:
8+
name: Yangshun Tay
9+
title: Front End Engineer @ Facebook
10+
url: https://github.com/yangshun
11+
image_url: https://github.com/yangshun.png
12+
13+
slorber:
14+
name: Sébastien Lorber
15+
title: Docusaurus maintainer
16+
url: https://sebastienlorber.com
17+
image_url: https://github.com/slorber.png

‎docs/configuration/_category_.json

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"label": "Configuration",
3+
"position": 3
4+
}
5+

‎docs/configuration/download-clients.md

+89
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
---
2+
sidebar_position: 3
3+
---
4+
5+
# Download clients
6+
7+
Go to `settings/clients` to setup clients.
8+
9+
Clients can be local or remote, as long as ports are open and auth available.
10+
11+
## General
12+
13+
Available download clients are. For more info check [ Supported download clients and actions #2 ](https://github.com/autobrr/autobrr/issues/2)
14+
15+
* qBittorrent
16+
* Deluge (v1+ and v2+)
17+
* Radarr
18+
* Sonarr
19+
* Lidarr
20+
21+
All clients have a test function to try out the connection details before saving.
22+
23+
## qBittorrent
24+
25+
- **Host**: Takes an ip or url without `http(s)`, eg `myserver.test`
26+
- **Port**: This is the WebUI port
27+
- **SSL**: Use this if the server is on https. It's usually not the case
28+
- **Username**: username
29+
- **Password**: password
30+
31+
:::tip
32+
33+
If qBittorrent is setup with eg Swizzin, it's common to bypass the reverse proxy and use url:webui-port directly. SSL should be off as well.
34+
35+
:::
36+
37+
### Rules
38+
39+
You can define some basic rules which can improve your performance for racing etc.
40+
41+
- **Enabled**: Disabled by default.
42+
- **Max active downloads**: Default 0 (unlimited) Limit the amount of active downloads, to give the maximum amount of bandwith and disk for the downloads.
43+
- **Ignore slow torrents**: Disabled by default.
44+
- **Download speed threshold**: If max active downloads is hit, but download speed is below this limit, download anyways. Unit in KB/s
45+
46+
## Deluge
47+
48+
- **Host**: Takes an ip or url without `http(s)`, eg `myserver.test`
49+
- **Port**: This is the WebUI port
50+
- **SSL**: Use this if the server is on https. It's usually not the case
51+
- **Username**: username
52+
- **Password**: password
53+
54+
:::tip
55+
56+
If Deluge is setup with eg Swizzin, it's common to bypass the reverse proxy and use url:webui-port directly. SSL should be off as well.
57+
58+
:::
59+
60+
### Rules
61+
62+
You can define some basic rules which can improve your performance for racing etc.
63+
64+
- **Enabled**: Disabled by default.
65+
- **Max active downloads**: Default 0 (unlimited) Limit the amount of active downloads, to give the maximum amount of bandwith and disk for the downloads.
66+
67+
## Radarr
68+
69+
- **Host**: Takes an ip or url with `http(s)`, eg `http://myserver.test/radarr`
70+
- **Apikey**: Api key
71+
- **Basic auth**: Disabled by default. Some setups need it, others don't. Try without first.
72+
- **Username**: username
73+
- **Password**: password
74+
75+
## Sonarr
76+
77+
- **Host**: Takes an ip or url with `http(s)`, eg `http://myserver.test/sonarr`
78+
- **Apikey**: Api key
79+
- **Basic auth**: Disabled by default. Some setups need it, others don't. Try without first.
80+
- **Username**: username
81+
- **Password**: password
82+
83+
## Lidarr
84+
85+
- **Host**: Takes an ip or url with `http(s)`, eg `http://myserver.test/lidarr`
86+
- **Apikey**: Api key
87+
- **Basic auth**: Disabled by default. Some setups need it, others don't. Try without first.
88+
- **Username**: username
89+
- **Password**: password

‎docs/configuration/indexers.md

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Indexers
6+
7+
Go to `settings/indexers` to add indexers.
8+
9+
When adding a new indexer, it sets up the IRC network and channels in the background.
10+
11+
Check [irc]( ./irc ) for more details.
12+
13+
## Supported indexers
14+
15+
Currently supported indexers. Check for more info [ Supported indexers #1 ](https://github.com/autobrr/autobrr/issues/1). If you want more added please either create a PR for it, post a comment on that issue or creata new one.
16+
17+
<details>
18+
<summary>Indexers</summary>
19+
20+
* AlphaRatio
21+
* BeyondHD
22+
* BTN
23+
* EMP
24+
* FileList
25+
* GazelleGames
26+
* HD-Torrents
27+
* IPTorrents
28+
* MTV
29+
* Milkie
30+
* Nebulance
31+
* Orpheus
32+
* PTP
33+
* RED
34+
* SuperBits
35+
* TorrentDay
36+
* TorrentLeech
37+
* TorrentSeeds
38+
* TranceTraffic
39+
* UHDBits
40+
41+
</details>
42+
43+
## Setup
44+
45+
Indexers usually need some keys to work.
46+
47+
The common ones are:
48+
* `passkey`
49+
* `rsskey`
50+
* `torrent_pass`
51+
* `auth_key`
52+
* `apikey`
53+
54+
When adding a new indexer you'll see which ones are needed. Check your indexers wiki/forum etc to find where they are located.

‎docs/configuration/irc.md

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# IRC
6+
7+
The initial setup of irc networks and channels are done during the setup of indexers.
8+
9+
If you need to edit something, you can do it here after.
10+
11+
:::caution Caution
12+
13+
There's currently no good way to monitor networks other than the log, looking for `Monitoring #channel`, `JOIN` and `PING`. This is coming in the future.
14+
15+
:::
16+
17+
## Setup
18+
19+
If you for some reason need to setup a network you can do that in the `settings/irc` tab.
20+
21+
Before setup, make sure you have generated neccessary keys for setup. Some networks have invite commands with extra keys. Some require to be registered with NickServ, while others don't.
22+
23+
* If NickServ Password is marked as `*`, required, then you need to have a registered account on that irc network.
24+
* If NickServ Account is marked as required, that's only used as nick, but supports NickServ auth.
25+
26+
You can group your primary user and a bot user to keep them separate, which is advisable. Here's a good guide how to do that [how-to-group-nicknames](https://digitalirc.org/2012/09/how-to-group-nicknames/).
27+
28+
29+
:::caution Caution
30+
31+
Quite a few indexers use the same network, specifically `irc.p2p-network.net`.
32+
33+
* If you have the same nick on multiple of them, it will reuse the same connection.
34+
* If you have more than one nick on the same network in will create a new connection.
35+
36+
Adding or removing `indexers/networks/channels` can therefore break things.
37+
38+
This is currently a bit buggy, but will be taken care of.
39+
40+
There's currently no good way to monitor networks other than the log, and looking for `Monitoring #channel`, `JOIN` and `PING`. This is coming in the future.
41+
42+
:::

‎docs/filters/_category_.json

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"label": "Filters",
3+
"position": 4
4+
}
5+

0 commit comments

Comments
 (0)