| Label | Key | Created | Last used | |
@@ -367,69 +367,55 @@ function copyKey() {
let body = format!(
r#"Settings
- Settings saved here are stored in the database and applied on the next restart.
- They override values in your YAML config file. Sections marked
- restart required
- take effect after restarting kindexr.
+ Changes here are saved to the database. Anything marked
+ needs restart
+ won't kick in until you restart kindexr.
{flash}
API Keys
-
API keys authenticate requests from Sonarr, Radarr, Lidarr, Readarr, and Prowlarr.
- Each app gets its own key so you can revoke access individually without affecting other clients.
- The key is entered in the indexer settings of each app — label it so you remember which is which.
+
Paste one of these into Sonarr, Radarr or any other app when adding this as an indexer.
+ Give each app its own key so you can cut one off without breaking the others.
{apikeys_section}
Torrent clients
-
kindexr can watch a torrent client for newly completed downloads and automatically
- publish them to Nostr as kind 2003 events. Only one client needs to be configured.
- Use labels (Deluge) or categories (qBittorrent) to control which torrents get published —
- leave them blank to publish everything that finishes downloading.
+
Hook up your torrent client and kindexr will post finished downloads to Nostr automatically.
+ You only need one client configured. If you only want certain torrents published, set a label or category
+ on them in your client and put it here. Leave it blank to publish everything that finishes.
{deluge_section}
{qbittorrent_section}
Network
-
Controls how kindexr connects to Nostr relays and external APIs (TMDB).
- Direct mode uses your server's default network. Tor and I2P route all outbound traffic through
- the respective anonymity network — the proxy must already be running on the same machine.
- SOCKS5 lets you point at any proxy, including PIA or Mullvad's built-in proxies.
+
How kindexr reaches the internet. Direct is the default. Tor and I2P need to already be running
+ on this machine. SOCKS5 works with PIA, Mullvad or any proxy you have set up.
{network_section}
Relays
-
Nostr relays kindexr subscribes to for incoming kind 2003 torrent events.
- More relays means broader coverage but higher bandwidth and connection overhead.
- kindexr tracks the last event seen per relay so it only requests new events on reconnect —
- removing and re-adding a relay will re-fetch its full history up to the backfill window.
+
The Nostr relays to pull torrent posts from. More relays means more content but uses more bandwidth.
+ kindexr remembers where it left off on each one so it won't re-download old stuff when it restarts.
{relays_section}
-
Curation & Trust
-
Controls which publishers kindexr trusts and indexes.
- The operator pubkey is your Nostr identity — kindexr reads your kind 3 follow list
- from the relay network every 24 hours and uses it to score publishers by how many hops away
- they are from you. Publishers outside your follow graph get a lower trust score.
- Enable WoT only to hard-drop events from anyone not in your graph.
- Use the Publishers page to manually override trust for specific pubkeys.
+
Trust
+
Your Nostr pubkey is used to figure out who to trust. People you follow get a higher score,
+ people your follows follow get a bit less, everyone else is untrusted. Turn on trusted only to ignore posts
+ from people completely outside that circle. You can always override individual publishers on the Publishers page.
{curation_section}
-
Ingest
-
Controls how much history kindexr requests when first connecting to a relay.
- The backfill window is applied per relay — if you add a new relay, kindexr will request events
- going back this many days. Existing relays only receive events newer than the last one seen,
- so changing this setting only affects relays added after the change.
+
History
+
When you add a new relay, how far back should it grab posts from?
+ This only applies to relays you haven't connected to before. Existing ones pick up from where they left off.
{ingest_section}
-
TMDB enrichment
-
When enabled, kindexr looks up movie and TV show metadata from The Movie Database
- for events that don't already have a TMDB ID tag. This helps Sonarr and Radarr match torrents
- to their library entries. Requires a free TMDB API read-access token — get one at
- themoviedb.org.
- Lookups are cached for 7 days to avoid hitting rate limits.
+
TMDB
+
Automatically fills in movie and TV show info so Sonarr and Radarr can match things properly.
+ You need a free API key from themoviedb.org to use this.
+ Results are cached so you won't run into rate limits.
{tmdb_section}
{js}"#