rays
8f19d88fc9
Measured on 2026-10-15: the feed list and item lists went out uncompressed at over 100 KB; ipx read 2.6 GB of feed bodies a day and the directory 3.9 GB. - ipx-web compresses with zstd or gzip, leaving out /api/events, which a compressor would hold back, and /media (#239). - A body identical to the last one (SHA-256 in feeds.body_hash) is taken as a 304, unless something is missing a read would fill or the check is forced; and a feed without a schedule of its own whose body has been the same waits a twelfth of that, up to four hours, beside the failure backoff (#242). 35 Patreon show feeds sent ~300 KB each hourly, about 250 MB a day. - The directory checks each feed every twelve hours, not six (#243). - reqwest accepts brotli and zstd too (#244). #240 (cache the feed list's counts) is left open: at production's size on the test Postgres that count takes 12 ms and All Subscriptions 32 ms, against 366 and 300 ms in production, so the cause is production's database, not the query (#241). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
33 lines
2.4 KiB
HTML
33 lines
2.4 KiB
HTML
<h1>The directory</h1>
|
|
<p>The directory gathers the public podcasts that iPX servers' listeners follow, and how many follow each. It never holds a file and never learns who listens.</p>
|
|
|
|
<h2>Browsing it</h2>
|
|
<p>Anyone can browse <a href="https://directory.ipxreader.app">directory.ipxreader.app</a> without signing in: the most followed, the categories, everything A to Z, and a page for each podcast with its latest episodes and its address, to subscribe to in any podcast app.</p>
|
|
|
|
<h2>Connecting your iPX</h2>
|
|
<p>In iPX, an admin opens Admin, Directory and enters the directory's address, <code>https://directory.ipxreader.app</code>, and the token its operator gave your server. Everyone on your server then has the Directory at the top of their list, and subscribes from it in one click.</p>
|
|
<p>Turn on sharing to add your server's podcasts to it. iPX sends only the podcasts' addresses and how many people on your server follow each, never who. It leaves out anything that looks private: a podcast someone marked Private, one with a login or a key in its address, and paid feeds such as Patreon's.</p>
|
|
|
|
<h2>Its API</h2>
|
|
<p>Anything the pages show, a program can read through the directory's API with a token: see the <a href="/docs/api/directory/">ipx-directory API reference</a>.</p>
|
|
|
|
<h2>Running your own</h2>
|
|
<p>The directory is in the same repository. Build it, give it a database (Postgres or SQLite) and a config file, and make a token for each server that will use it:</p>
|
|
<pre><code>docker build -f Dockerfile.directory -t ipx-directory .</code></pre>
|
|
<pre><code>services:
|
|
ipx-directory:
|
|
image: ipx-directory
|
|
container_name: ipx-directory
|
|
restart: unless-stopped
|
|
environment:
|
|
DIRECTORY_DATABASE_URL: "postgres://ipx_directory:password@db-host:5432/ipx_directory"
|
|
ports:
|
|
- "8100:8100"
|
|
volumes:
|
|
- ./directory:/config:ro # directory.toml</code></pre>
|
|
<pre><code># directory/directory.toml
|
|
bind = "0.0.0.0:8100"
|
|
database_url_env = "DIRECTORY_DATABASE_URL"</code></pre>
|
|
<pre><code>docker exec ipx-directory ipx-directory token new my-server --access rw</code></pre>
|
|
<p>That prints the token, to give to the server, and the lines to add to <code>directory.toml</code>, which keeps only its SHA-256. The directory reads the file again within a minute, so adding or revoking a token needs no restart. It checks each podcast every twelve hours.</p>
|