<!DOCTYPE html> <html lang="en-US"> <head> <meta charset="UTF-8"> <meta http-equiv="X-UA-Compatible" content="IE=Edge"> <link rel="stylesheet" href="/sharerr-rs/assets/css/just-the-docs-default.css"> <link rel="stylesheet" href="/sharerr-rs/assets/css/just-the-docs-head-nav.css" id="jtd-head-nav-stylesheet"> <style id="jtd-nav-activation"> .site-nav ul li a { background-image: none; } </style> <script src="/sharerr-rs/assets/js/vendor/lunr.min.js"></script> <script src="/sharerr-rs/assets/js/just-the-docs.js"></script> <meta name="viewport" content="width=device-width, initial-scale=1"> <!-- Begin Jekyll SEO tag v2.8.0 --> <title>sharerr | Share your media library with friends, over the tools you already run.</title> <meta name="generator" content="Jekyll v3.10.0" /> <meta property="og:title" content="sharerr" /> <meta property="og:locale" content="en_US" /> <meta name="description" content="Share your media library with friends, over the tools you already run." /> <meta property="og:description" content="Share your media library with friends, over the tools you already run." /> <link rel="canonical" href="https://ivylikethevine.github.io/sharerr-rs/docs/prowlarr/sharerr.yml" /> <meta property="og:url" content="https://ivylikethevine.github.io/sharerr-rs/docs/prowlarr/sharerr.yml" /> <meta property="og:site_name" content="sharerr" /> <meta property="og:type" content="website" /> <meta name="twitter:card" content="summary" /> <meta property="twitter:title" content="sharerr" /> <script type="application/ld+json"> {"@context":"https://schema.org","@type":"WebPage","description":"Share your media library with friends, over the tools you already run.","headline":"sharerr","url":"https://ivylikethevine.github.io/sharerr-rs/docs/prowlarr/sharerr.yml"}</script> <!-- End Jekyll SEO tag --> </head> <body> <a class="skip-to-main" href="#main-content">Skip to main content</a> <svg xmlns="http://www.w3.org/2000/svg" class="d-none"> <symbol id="svg-link" viewBox="0 0 24 24"> <title>Link</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link"> <path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path> </svg> </symbol> <symbol id="svg-menu" viewBox="0 0 24 24"> <title>Menu</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu"> <line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line> </svg> </symbol> <symbol id="svg-arrow-right" viewBox="0 0 24 24"> <title>Expand</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right"> <polyline points="9 18 15 12 9 6"></polyline> </svg> </symbol> <!-- Feather. MIT License: https://github.com/feathericons/feather/blob/master/LICENSE --> <symbol id="svg-external-link" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-external-link"> <title id="svg-external-link-title">(external link)</title> <path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"></path><polyline points="15 3 21 3 21 9"></polyline><line x1="10" y1="14" x2="21" y2="3"></line> </symbol> <symbol id="svg-doc" viewBox="0 0 24 24"> <title>Document</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-file"> <path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path><polyline points="13 2 13 9 20 9"></polyline> </svg> </symbol> <symbol id="svg-search" viewBox="0 0 24 24"> <title>Search</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search"> <circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line> </svg> </symbol> <!-- Bootstrap Icons. MIT License: https://github.com/twbs/icons/blob/main/LICENSE.md --> <symbol id="svg-copy" viewBox="0 0 16 16"> <title>Copy</title> <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard" viewBox="0 0 16 16"> <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1h1a1 1 0 0 1 1 1V14a1 1 0 0 1-1 1H3a1 1 0 0 1-1-1V3.5a1 1 0 0 1 1-1h1v-1z"/> <path d="M9.5 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3zm-3-1A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3z"/> </svg> </symbol> <symbol id="svg-copied" viewBox="0 0 16 16"> <title>Copied</title> <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard-check-fill" viewBox="0 0 16 16"> <path d="M6.5 0A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3Zm3 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3Z"/> <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1A2.5 2.5 0 0 1 9.5 5h-3A2.5 2.5 0 0 1 4 2.5v-1Zm6.854 7.354-3 3a.5.5 0 0 1-.708 0l-1.5-1.5a.5.5 0 0 1 .708-.708L7.5 10.793l2.646-2.647a.5.5 0 0 1 .708.708Z"/> </svg> </symbol> </svg> <header class="side-bar"> <div class="site-header"> <a href="/sharerr-rs/" class="site-title lh-tight"> sharerr </a> <button id="menu-button" class="site-button btn-reset" aria-label="Menu" aria-expanded="false"> <svg viewBox="0 0 24 24" class="icon" aria-hidden="true"><use xlink:href="#svg-menu"></use></svg> </button> </div> <nav aria-label="Main" id="site-nav" class="site-nav"> <ul class="nav-list"><li class="nav-list-item"><a href="/sharerr-rs/docs/prowlarr/" class="nav-list-link">A Prowlarr definition</a></li><li class="nav-list-item"><a href="/sharerr-rs/docs/ALTERNATIVES.html" class="nav-list-link">Alternatives</a></li><li class="nav-list-item"><a href="/sharerr-rs/docs/ARCHITECTURE.html" class="nav-list-link">Architecture</a></li><li class="nav-list-item"><a href="/sharerr-rs/docs/CODEQL.html" class="nav-list-link">CodeQL findings</a></li><li class="nav-list-item"><a href="/sharerr-rs/docs/COMPATIBILITY.html" class="nav-list-link">Compatibility</a></li><li class="nav-list-item"><a href="/sharerr-rs/docs/dashboards/" class="nav-list-link">Dashboards</a></li><li class="nav-list-item"><a href="/sharerr-rs/docs/DESIGN.html" class="nav-list-link">Design brief</a></li><li class="nav-list-item"><a href="/sharerr-rs/docs/" class="nav-list-link">Documentation</a></li><li class="nav-list-item"><a href="/sharerr-rs/docs/GOVERNANCE.html" class="nav-list-link">Governance</a></li><li class="nav-list-item"><a href="/sharerr-rs/docs/OPENSSF-IMPROVEMENTS.html" class="nav-list-link">OpenSSF Best Practices Badge — improvements</a></li><li class="nav-list-item"><a href="/sharerr-rs/docs/RELEASING.html" class="nav-list-link">Releasing</a></li><li class="nav-list-item"><a href="/sharerr-rs/docs/plans/repo-simplification.html" class="nav-list-link">Repo-wide simplification</a></li><li class="nav-list-item"><a href="/sharerr-rs/RESUME.html" class="nav-list-link">Resuming the repo-wide simplification</a></li><li class="nav-list-item"><a href="/sharerr-rs/docs/ROADMAP.html" class="nav-list-link">Roadmap</a></li><li class="nav-list-item"><a href="/sharerr-rs/scratch/" class="nav-list-link">Scratch</a></li><li class="nav-list-item"><a href="/sharerr-rs/docs/SECURITY.html" class="nav-list-link">Security policy</a></li><li class="nav-list-item"><a href="/sharerr-rs/docs/SETTINGS.html" class="nav-list-link">Settings reference</a></li><li class="nav-list-item"><a href="/sharerr-rs/docs/SUPPORT.html" class="nav-list-link">Support</a></li><li class="nav-list-item"><a href="/sharerr-rs/docs/TESTING.html" class="nav-list-link">Testing</a></li><li class="nav-list-item"><a href="/sharerr-rs/docs/API.html" class="nav-list-link">The API</a></li><li class="nav-list-item"><a href="/sharerr-rs/docs/LIGHTHOUSE.html" class="nav-list-link">The lighthouse</a></li><li class="nav-list-item"><a href="/sharerr-rs/" class="nav-list-link">sharerr</a></li></ul> </nav> <div class="d-md-block d-none site-footer"> This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll. </div> </header> <div class="main" id="top"> <div id="main-header" class="main-header"> <div class="search" role="search"> <div class="search-input-wrap"> <input type="text" id="search-input" class="search-input" tabindex="0" placeholder="Search sharerr" autocomplete="off"> <label for="search-input" class="search-label"> <span class="sr-only">Search sharerr</span> <svg viewBox="0 0 24 24" class="search-icon" aria-hidden="true"><use xlink:href="#svg-search"></use></svg> </label> </div> <div id="search-results" class="search-results"></div> </div> </div> <div class="main-content-wrap"> <div id="main-content" class="main-content"> <main> <h--- # A Prowlarr indexer definition for one friend's sharerr. Prowlarr only # offers a Cardigann indexer the base URLs its definition lists, so this file # is per host: replace the one URL under `links:` with the address of the # sharerr you were given a key for, ending in `/`. docs/prowlarr/README.md # says where the file goes. id: sharerr name: sharerr description: "A friend's sharerr instance: what they share from their own library" language: en-US type: private encoding: UTF-8 links: - https://sharerr.example.com/ caps: categorymappings: - {id: 2000, cat: Movies, desc: "Movies"} - {id: 3000, cat: Audio, desc: "Audio"} - {id: 5000, cat: TV, desc: "TV"} - {id: 6000, cat: XXX, desc: "XXX"} - {id: 7000, cat: Books, desc: "Books"} modes: search: [q] tv-search: [q, season, ep, tvdbid, imdbid] movie-search: [q, imdbid, tmdbid] music-search: [q] book-search: [q] allowrawsearch: true settings: - name: apikey type: text label: API Key - name: info_key type: info label: About your API key default: "The key your friend gave you with their feed URL. It is yours alone, so they can revoke it without affecting anyone else." search: paths: - path: api response: type: xml inputs: apikey: "" t: "search" q: "" cat: "" season: "" ep: "" tvdbid: "" imdbid: "" tmdbid: "" # A wrong or revoked key answers with Torznab's own error document. error: - selector: error message: selector: error attribute: description rows: selector: rss > channel > item fields: category: selector: "[name=category]" attribute: value title: selector: title details: selector: link download: selector: enclosure attribute: url infohash: selector: "[name=infohash]" attribute: value imdbid: selector: "[name=imdbid]" attribute: value optional: true tvdbid: selector: "[name=tvdbid]" attribute: value optional: true tmdbid: selector: "[name=tmdbid]" attribute: value optional: true date: selector: pubDate size: selector: size seeders: selector: "[name=seeders]" attribute: value leechers: selector: "[name=peers]" attribute: value downloadvolumefactor: selector: "[name=downloadvolumefactor]" attribute: value uploadvolumefactor: selector: "[name=uploadvolumefactor]" attribute: value # torznab xml </main> <hr> <footer> <div class="d-md-none mt-4 fs-2"> This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll. </div> </footer> </div> </div> <div class="search-overlay"></div> </div> </body> </html>
