Because everything on the Web eventually loops back onto itself.

• View all entries in the ring
• Automatically provided JavaScript to embed a simple rendering of all entries
• Create, update, and delete entries
• Linkrot checking, with Web Archive fallback url for dead links (when possible)
• Optional linkrot event logging to Discord channel
  • Text error log fallback if disabled

Starting with version 1.3.0, new filtering options are available to restrict the provided webring items. These filters are supported on both the root URL and the simple embed endpoints. These options are provided through query parameters to the URLs.

• include_rotted: bool = "yes": Include links that have been determined to be rotten.
• exclude_origin: bool = "yes": Remove the site requested the webring from the results, if present.

Starting with version 1.3.0, a JavaScript file is provided to generate and embed a simple rendering of the webring into your site. It includes the entire ring in the script, preventing any additional requests to fetch ring entries.

To use it, create an HTML element in your page with a CSS ID of webring-embed-area. If the selector is found and there are webring items to display, the webring will be injected into that area of your site. A simple setup might look as follows:

<section id="webring-embed-area">
  <noscript>The webring could be loaded because your browser doesn't support running JavaScript.</noscript>
</section>

<!-- Load the webring -->
<script src="https://example.com/webring-embed.js"></script>

As illustrated, a no-js fallback is recommended for visitors to your site that may have JavaScript execution disabled or lack JS support completely in their browser.

Note this could potentially be slow, depending on the number of entries in the ring. This script is also not minified, which could also increase your page load time. If you want or need greater control over loading and displaying the ring, it is suggested to manually call the ring's root URL to fetch the entries and display them as you desire.

• Flask secret key (SECRET_KEY)
• Flask app environment (FLASK_ENV) set to "production"
• Absolute path to SQLite file (DB_PATH)
• JSON list of auth keys for all non-GET operations (AUTH_KEYS)
• Integer number of times supposed rotted links should be checked (TIMES_FAILED_THRESHOLD, default: 10)
• Discord linkrot event logging boolean (ENABLE_DISCORD_LOGGING, default: False)
  • Discord webhook URL (DISCORD_WEBHOOK_URL)

1. Install Python 3.11+, Poetry 1.6.0+, and VS Code
2. Create required secret keys (default: /app/secrets or environment)
3. Run poetry install
4. Launch the API using the provided VS Code launch configuration
5. Auto-generated API docs are available at /docs
6. Run tests with poetry run pytest or through VS Code

1. docker build -t webring:latest .
2. docker-compose up -d

2021-2024 Caleb

MIT