Skip to content

Commit

Permalink
update(v6-migration): add step by step guide (#56)
Browse files Browse the repository at this point in the history
Step by step guide
  • Loading branch information
ShanaryS authored Oct 7, 2024
1 parent 9e593aa commit 9076063
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/reference/utils.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,11 @@ cross-seed gen-config -d

### `cross-seed clear-cache`

Clear the cache of previous decisions that are never rechecked, usually unnecessary.
:::danger
Do not use unless instructed to, this rarely necessary. Seek support if you believe it's necessary.
:::

Clear the cache without causing torrents to be re-snatched and reset the timestamps for [`excludeOlder`](../basics/options.md#excludeolder) and [`excludeRecentSearch`](../basics/options.md#excluderecentsearch).

### `cross-seed test-notification`

Expand Down
12 changes: 12 additions & 0 deletions docs/v6-migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -396,6 +396,18 @@ Here is a short list of other changes made in v6. These are some of the behind-t

## Extra

### Step-by-Step Guide

:::danger
Do **_NOT_** skip straight to this section. All the information covered on this page is important and can potentially cause disastrous consequences if ignored.
:::

- Update your config to modify, add, and remove the options covered in the [breaking changes section](#breaking-changes-tldr).
- Ensure you've read through this page and have updated your options to take advantage of the new capabilities and modified behavior.
- Set [rssCadence](./basics/options.md#rsscadence) and [searchCadence](./basics/options.md#searchcadence) to `null`. Start `cross-seed` and correct any configuration errors that `cross-seed` displays.
- Once `cross-seed` is running, check the verbose logs to ensure autobrr announces are not failing.
- Finally, set your desired `rssCadence` and `searchCadence` and restart `cross-seed`.

### [`flatLinking`](./basics/options.md#flatlinking) Migration

:::caution
Expand Down

0 comments on commit 9076063

Please sign in to comment.