Skip to content

self-hosting.mdx

Latest commit

 

History

History
29 lines (21 loc) · 1.83 KB

self-hosting.mdx

File metadata and controls

29 lines (21 loc) · 1.83 KB
title Self-Host Your Own Instance
description Start self-hosting with the current html2rss-web setup and deployment docs.
sidebar
order
3

This page is the short routing point for self-hosting. The current setup and deployment instructions live under the html2rss-web docs so the Docker, .env, token, and generated-feed guidance only exists in one place.

Recommended Path

  1. Run html2rss-web locally to verify your own instance with a generated feed first.
  2. Deploy html2rss-web to production when you are ready to expose or operate it.
  3. Use automatic feed generation to keep the token-gated page-URL workflow enabled on your instance.

What To Expect

  • html2rss-web is the recommended self-hosted product surface.
  • Automatic feed generation is the main self-hosted onboarding flow.
  • Included feeds are the packaged fallback path when that catalog already covers the site you want.
  • Automatic feed generation is disabled by default in production unless you enable it.
  • The generated API contract is published as OpenAPI at /openapi.yaml.
  • Custom config work belongs in the core html2rss docs and JSON Schema.

Share Your Instance

Running a reliable deployment benefits the broader community. Share your server with the broader community by adding it to the community instance list once it is stable and you are ready for other readers. Include details such as uptime expectations, moderation policy, and contact information so people know what to expect.

Thanks for investing the time to share html2rss with others. Each new instance expands the open web and helps readers stay in control of the stories they follow.