Documentation

HostFlow management platform — documentation and reference.

Getting Started

HostFlow allows you to host websites, manage Discord bots, configure port forwarding, set up email, and more — all from a single dashboard.

API Key

You need an API key to access the management interface. Contact your administrator to get one. The default admin key is configured in the environment variable HOSTFLOW_API_KEY.

Sites

Create and manage websites. Each site gets a public directory where you can upload HTML, CSS, JS, and other static files.

• Create: Use the dashboard or API to create a new site
• Upload: Upload files via the dashboard or API
• Editor: Edit files directly in the browser
• Domain: Assign a custom domain to your site
• SSL: Automatic Let's Encrypt certificate generation

Discord Bots

Create and manage Discord bots with a visual block-based programming interface.

• Create a bot with a name and token
• Add commands using the visual block builder
• Supports prefix commands, slash commands, and event handlers
• Blocks include logic, loops, messages, moderation, variables, and HTTP requests

Port Forwarding

Forward TCP/UDP ports from the server to external destinations. Supports domain-based routing and dynamic IP updates.

Mail Provider

Configure email services for your domains with automatic DNS record generation.

DNS Management

HostFlow includes an authoritative DNS server. Add zones and manage records directly from the dashboard.

ConnectFlow

Peer-to-peer tunnel system for connecting devices directly via a virtual network.

API Reference

All dashboard functionality is available via REST API endpoints under /api/. Authentication is done via the X-API-Key header or session cookie.

Session

• POST /api/session/login — Login with API key, sets session cookie
• POST /api/session/logout — Clear session
• GET /api/session/check — Check if session is valid

Sites

• GET /api/sites — List all sites
• POST /api/sites — Create a new site
• GET /api/sites/<name> — Get site details
• DELETE /api/sites/<name> — Delete a site
• POST /api/sites/<name>/toggle — Enable/disable a site

Bots

• GET /api/bots — List all bots
• POST /api/bots — Create a new bot
• POST /api/bots/<name>/toggle — Start/stop a bot
• POST /api/bots/<name>/commands — Save commands for a bot

Support

For issues or feature requests, please contact the administrator.