Skip to content

Commit

Permalink
overhaul(everything): complete overhaul and update to docs and v6 (#26)
Browse files Browse the repository at this point in the history
* overhaul(everything): complete overhaul and update to docs and v6

* update(config): css and default theme changes

theme(css): mobile friendly codeblocks and theming

update(css): color changes
  • Loading branch information
zakkarry authored May 9, 2024
1 parent 160ab95 commit 24029ef
Show file tree
Hide file tree
Showing 15 changed files with 484 additions and 277 deletions.
16 changes: 7 additions & 9 deletions docs/basics/daemon.md
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ For rTorrent, you'll have to edit your `.rtorrent.rc` file.
| **InfoHash** | `curl -XPOST http://localhost:2468/api/webhook?apikey=YOUR_API_KEY --data-urlencode "infoHash=%I"` |
| **Data (Path)** | `curl -XPOST http://localhost:2468/api/webhook?apikey=YOUR_API_KEY --data-urlencode "path=%F"` |
:::tip Docker
:::info Docker
You can use `http://cross-seed:2468` instead of `http://localhost:2468` with
Docker networks. `localhost` will not work for Docker. You will need to use your
host's IP (e.g. 192.x or 10.x) if not using custom Docker networks.
Expand All @@ -301,7 +301,7 @@ you should create a shell script with your preferred commands and parameters.
If you're already using the following in the **Run external program on torrent completion** box
```shell
oldcommand %N
<curl command> %N
```
You can add infoHash searching using the following script:
Expand All @@ -315,13 +315,11 @@ You can add infoHash searching using the following script:
Then add this in qBittorrent's settings to execute the script:

```shell
/bin/bash ./qBittorrent/yourscriptname.sh "%N" "%I"
/bin/bash ./qBittorrent/yourscriptname.sh "%N" "%I"
```

:::info

You may need to adjust the variables above that qBittorrent sends to the script.

:::

### Transmission
Expand All @@ -335,7 +333,7 @@ You may need to adjust the variables above that qBittorrent sends to the script.
curl -XPOST http://localhost:2468/api/webhook?apikey=YOUR_API_KEY --data-urlencode "infoHash=$TR_TORRENT_HASH"
```

:::tip Docker
:::info Docker

You can use `http://cross-seed:2468` instead of `http://localhost:2468` with
Docker networks. `localhost` will not work for Docker. You will need to use your
Expand Down Expand Up @@ -375,7 +373,7 @@ You may need to adjust the variables above that qBittorrent sends to the script.
# curl -XPOST http://localhost:2468/api/webhook?apikey=YOUR_API_KEY --data-urlencode "path=$torrentpath/$torrentname"
```
:::tip Docker
:::info Docker
You can use `http://cross-seed:2468` instead of `http://localhost:2468` with Docker networks.
`localhost` will not work for Docker. You will need to use your host's IP (e.g. 192.x or 10.x)
Expand Down Expand Up @@ -432,9 +430,9 @@ You can combine [`searchCadence`](../basics/options#searchcadence) with [`exclud
and [`excludeOlder`](../basics/options#excludeolder) - and even [`searchLimit`](../basics/options#searchlimit) for a more frequent and
smoother search load. This results in searching with the following criteria applied:

- `excludeRecentSearch` will exclude any torrents searched for **from the current moment back the specified time**.
- [`excludeRecentSearch`](./options.md#excluderecentsearch) will exclude any torrents searched for **from the current moment back the specified time**.

- `excludeOlder` will exclude any torrents that were first discovered for cross-seeding a **longer time ago than the specified time**.
- [`excludeOlder`](./options.md#excludeolder) will exclude any torrents that were first discovered for cross-seeding a **longer time ago than the specified time**.

```js
searchCadence: "1 week",
Expand Down
88 changes: 57 additions & 31 deletions docs/basics/faq-troubleshooting.md

Large diffs are not rendered by default.

10 changes: 3 additions & 7 deletions docs/basics/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,20 +83,18 @@ cross-seed search \
If you were lucky, you've already got your first cross-seed in your current
directory!

:::caution

:::info
`cross-seed`, by default, is particular about the contents of torrents you feed
it. It will ignore torrents with non-video files in them, and it will ignore
torrents that look like single episodes.

Use these command line flags to override the default:
Use the command line flags to override any defaults:
`--include-episodes --include-non-videos`

These command line arguments are always configurable in the config.js file (generated with gen-config).
You won't have to specify them if they are set unless you wish to override the settings temporarily.

Below we will cover the configuration process.

:::

## Scaling Up
Expand All @@ -119,12 +117,10 @@ After that, you will find an autogenerated config file at
`~/.cross-seed/config.js` or `AppData\Local\cross-seed\config.js`. Open this file
in your editor of choice, and start editing.

:::tip

:::info
The config file uses JavaScript syntax. Each option in the config (and each
element in a list) must be separated by a comma, and make sure to wrap your
strings in "quotation marks" or array (multiple strings) objects in []'s

:::

The only **required** options are [`torznab`](../basics/options.md#torznab),
Expand Down
Loading

0 comments on commit 24029ef

Please sign in to comment.