Skip to content
html2rss logo - Turn any website into RSS html2rss

Deployment & Production

html2rss-web is published on Docker Hub, making it easy to deploy with Docker. The docker-compose.yml from our Installation Guide provides a solid foundation for both development and production use.

Quick Start

Section titled “Quick Start”

If you’ve already set up html2rss-web locally, you’re ready to deploy it to production. The same Docker configuration works for both environments.

Production Best Practices

Section titled “Production Best Practices”

When hosting a public instance that others will use, please follow these essential guidelines:

Security Essentials

Section titled “Security Essentials”
  • Use a reverse proxy (nginx, Apache, or Cloudflare) to handle SSL termination and rate limiting
  • Enable HTTPS only - redirect all HTTP traffic to HTTPS
  • Set strong passwords for health check and auto-source authentication
  • Restrict access to admin endpoints and sensitive configuration

Reliability & Monitoring

Section titled “Reliability & Monitoring”
  • Enable auto-updates using watchtower or similar tools
  • Monitor the health check endpoint (/health_check.txt) to detect issues early
  • Set up logging to track errors and performance
  • Use environment variables for configuration instead of hardcoded values

Performance Optimization

Section titled “Performance Optimization”
  • Configure appropriate resource limits for your Docker containers
  • Use a CDN for static assets if serving many users
  • Monitor memory usage - html2rss-web can be memory-intensive with large feeds
  • Set up caching for frequently accessed feeds

Environment Configuration

Section titled “Environment Configuration”

For production, update your environment variables:

environment:
  RACK_ENV: production
  LOG_LEVEL: warn
  HEALTH_CHECK_USERNAME: your-secure-username
  HEALTH_CHECK_PASSWORD: your-very-secure-password
  BASE_URL: https://your-domain.com

Share Your Instance

Section titled “Share Your Instance”

Once your instance is running smoothly:

  • Add it to our community wiki so others can discover it
  • Test thoroughly with various feed types before sharing
  • Monitor usage and be prepared to scale if needed

Need Help?

Section titled “Need Help?”