Hostify

User Guide

  • Installation
    • Requirements
    • Install Hostify
    • Cloudflare Setup
      • Step 1: Get API Token
      • Step 2: Set Environment Variable
      • Step 3: Add Domain to Cloudflare
    • Verify Installation
  • Quick Start
    • Basic Usage
    • Step-by-Step Tutorial
      • Step 1: Install Hostify
      • Step 2: Set Up Cloudflare
      • Step 3: Start Your Application
      • Step 4: Host It with Hostify
      • Step 5: Access Your Site
    • Common Patterns
      • Host Static Files
      • Host Flask Application
      • Custom API Token
    • Next Steps
  • User Guide
    • Understanding Hostify
    • Hosting Modes
      • Existing Server Mode
      • Static Files Mode
    • Configuration Options
      • Domain Configuration
      • API Token Configuration
    • Advanced Patterns
      • Multiple Applications
      • Integration with Web Frameworks
      • Production Deployment
    • Best Practices
    • Security Considerations
    • Performance Tips
    • Troubleshooting
  • Examples
    • Basic Examples
      • Static Website
      • Existing Local Server
    • Web Framework Examples
      • Flask Application
      • Django Project
      • FastAPI Application
      • Streamlit Dashboard
      • Node.js Application
    • Advanced Examples
      • Multiple Environments
      • API with Custom Token
      • Documentation Site
      • Portfolio Website
      • Webhook Testing
      • Demo/Presentation Server
    • Tips for Examples
    • Next Steps
  • Troubleshooting
    • Installation Issues
      • “pip install hostify” fails
      • Import Error
    • Configuration Issues
      • “Cloudflare API token not found”
      • “No Cloudflare accounts found”
      • “Zone not found for domain”
    • Server Issues
      • “No server found on port X”
      • “Port already in use”
    • Connection Issues
      • Site shows 404 or “Not Found”
      • “Tunnel process stopped unexpectedly”
      • Site loads slowly
    • Cleanup Issues
      • “Failed to delete tunnel”
      • DNS record not deleted
    • Platform-Specific Issues
      • Windows: “cloudflared.exe not found”
      • Linux: Permission denied
      • macOS: “cloudflared cannot be opened”
    • Getting Help
    • Common Error Messages

API Documentation

  • API Reference
    • Host Class
      • Host
        • Host.__init__()
        • Host.cleanup()
        • Host.serve()
      • Constructor Parameters
        • Host
      • Methods
        • serve()
        • cleanup()
    • Exceptions
    • Cloudflare Module
      • Cloudflare
        • Cloudflare.BASE_URL
        • Cloudflare.__init__()
        • Cloudflare.configure_tunnel_route()
        • Cloudflare.create_dns_record()
        • Cloudflare.create_tunnel()
        • Cloudflare.delete_dns_record()
        • Cloudflare.delete_tunnel()
        • Cloudflare.find_existing_record()
        • Cloudflare.get_account_id()
        • Cloudflare.get_accounts()
        • Cloudflare.get_headers()
        • Cloudflare.get_zone_id()
        • Cloudflare.list_dns_records()
        • Cloudflare.list_tunnels()
        • Cloudflare.save_credentials()
      • CloudflareAPIError
    • Cloudflared Module
      • Cloudflared
        • Cloudflared.DOWNLOAD_URLS
        • Cloudflared.__init__()
        • Cloudflared.get_binary_path()
        • Cloudflared.get_logs()
        • Cloudflared.is_running()
        • Cloudflared.run_tunnel()
        • Cloudflared.stop_tunnel()
      • CloudflaredError
    • Utility Functions
      • ensure_dir()
      • get_home_dir()
      • is_port_in_use()
      • start_static_server()
      • validate_server()
    • Type Hints

Additional Information

  • Contributing
    • How to Contribute
    • Development Setup
    • Running Tests
    • Code Style
    • Type Checking
    • Submitting Changes
    • Pull Request Guidelines
    • Reporting Bugs
    • Feature Requests
    • Code of Conduct
    • License
    • Questions?
  • Changelog
    • [0.2.1] - 2026-01-16
      • Fixed
      • Changed
      • Added
    • [0.1.1] - 2026-01-11
      • Changed
    • [0.1.0] - 2026-01-11
      • Added
      • Fixed
      • Tested
    • Planned Features
Hostify
  • Search

© Copyright 2026, Yuvraj Arora.