Documentation

Complete guide to setting up and using HakoSpace

Getting Started

Get HakoSpace up and running in under a minute.

1

Download the server binary from the download page for your platform (Linux or Windows).

2

Run the binary — the first launch automatically generates a configuration file (.env) with sensible defaults.

3

The first user to register becomes the server Owner automatically with full administrative privileges.

4

Connect via your web browser at http://localhost:8080 or use the HakoSpace desktop app.

Registration Modes

  • Open — anyone can create an account
  • Invite Only — registration requires a valid invite code
  • Closed — registration is disabled entirely
Registration settings

Interface Overview

HakoSpace uses a familiar 3-panel layout designed for efficient communication.

Left Sidebar — channel list organized by groups, DM section, user status selector (Online / Idle / DND / Invisible), voice controls (mute / deafen / screen share), and settings buttons.

Center Panel — the main message area where conversations happen.

Right Panel — member list for the current channel or server.

All panels are resizable. Drag the borders to customize your layout.

HakoSpace interface overview

Channels

Channels are where conversations happen. HakoSpace supports two channel types.

#

Text channels (#) — for messages, files, and media sharing.

♪

Voice channels (♪) — for real-time voice and video communication.

Channel Features

  • Channel Groups — organize channels into collapsible categories
  • Public & Private — control visibility and access per channel
  • Permissions — granular control over send, edit, delete, and pin messages
  • Message Retention — configure message count limits and storage limits per channel
  • OBS WHIP Streaming — stream to voice channels via WHIP protocol with token-based authentication
Channel management

Messaging

Rich messaging with everything you need for productive conversations.

  • Send messages with text, files, and images
  • Edit and delete your own messages
  • React to messages with emoji
  • Pin important messages for quick reference
  • Reply to messages to create threaded conversations
  • Spoiler tags to hide sensitive content
  • Automatic URL previews and link embeds
  • File upload with drag & drop support
Text messaging

Voice & Video

Full-featured voice and video communication powered by WebRTC.

  • Join and leave voice channels freely
  • Mute / Unmute your microphone
  • Deafen / Undeafen to mute all incoming audio
  • Per-user volume control
  • Voice Activity Detection (VAD) with adjustable sensitivity threshold
  • Noise suppression — RNNoise AI-based or browser native
  • Echo cancellation
  • Audio input / output device selection
  • Confirmation dialog when switching channels to prevent accidental disconnects
Voice and audio settings

Screen Sharing

Share your screen with flexible quality and layout options.

  • Start / stop screen sharing in voice channels
  • Quality presets — resolution and framerate configurable by admin
  • Video codec selection: VP9, VP8, AV1, H.264
  • Per-user mute in screen share view
  • Fullscreen and popout viewing options
  • Toggle to hide non-sharing participants
  • Vertical / horizontal layout toggle
  • OBS streaming via WHIP protocol for professional broadcasting
Screen sharing

Direct Messages

Private 1-on-1 conversations with all the features of channel messaging.

  • Start a DM from the member list or DM section
  • Full message editing, deletion, and pinning
  • Pin / unpin conversations in your DM list for quick access
  • 1-on-1 voice calls with accept / decline
  • Typing indicators
  • Unread message tracking
  • AI bot conversations via DM
Direct messages

User Settings

Customize your profile and application experience.

Account

  • Avatar upload
  • Nickname and bio
  • Profile border color
  • Password change

Preferences

  • Date format
  • Time format (12-hour / 24-hour)

Audio

  • Input / output device selection
  • Volume control
  • Noise suppression mode
  • Echo cancellation toggle
  • Voice activity threshold
  • Screen share quality and codec

Language

  • English
  • Traditional Chinese

Desktop (Desktop App Only)

  • Link open mode (internal / external browser)
  • Close button behavior (minimize to tray / quit)
  • Voice input mode (voice activity / push-to-talk)
  • Keyboard shortcut configuration

About

  • Version information
  • Protocol version
  • Build information
  • License details
  • EULA and Privacy Policy links
Voice and audio settings

Server Administration

Admin Only

Comprehensive server management tools available to Owners and Admins.

Overview

Server name, icon, and default channel configuration.

Branding

Login banner image, welcome message, and login page message.

Media & Uploads

Maximum upload size, file extension blacklist, and screen share quality presets.

Notifications

Voice join/leave sounds, call ringtones, and per-action notification sounds.

Direct Messages

Message retention, call bitrate, file upload size limit, and DM statistics.

Channels

Create, delete, rename channels and groups. Configure permissions, retention, and WHIP streaming.

Members

User list, role assignment (Owner / Admin / Member), kick, and ban with reason.

Badges

Create and assign badges, display settings, system vs custom badges.

User Groups

Create and assign groups with member management.

Dashboard

Server statistics — users, messages, channels, database size, uptime, and memory usage.

System Monitor

Real-time CPU, RAM, network I/O, and Go runtime memory metrics.

Registration

Mode selection (open / invite / closed), invite code management with expiration.

Announcement

Global announcements displayed to all users.

Audit Log

Administrative action history with filtering.

Security

Rate limiting (messages / uploads per minute) and IP bans.

AI Settings

Provider configuration, tool management, and MCP invocation logs.

Developer Tools

WebSocket monitor and server terminal for debugging.

Server dashboard
Registration settings

AI Agent

Experimental

AI-powered assistant with multi-provider support and server management capabilities.

  • Multi-provider support: Anthropic Claude, OpenAI GPT, Google Gemini
  • Start AI chat from the DM section using the star icon
  • Tool calling capabilities for server management tasks
  • Configurable by admins — enable/disable, model selection, rate limits

AI Agent is an experimental feature and may change in future updates.

AI agent settings

Desktop App

Native desktop experience with advanced features.

  • Multi-server support — connect to multiple HakoSpace servers
  • Encrypted credential storage using platform-native safeStorage
  • System tray integration
  • Per-application audio capture on Linux (PipeWire)
  • Configurable link open mode and close button behavior
  • Voice input mode selection (voice activity / push-to-talk)
  • Keyboard shortcuts for calls, mute, and deafen
Desktop app settings

Keyboard Shortcuts

Shortcuts are configurable from the desktop app settings tab.

Desktop app only. Configured in Settings → Desktop.

  • Accept Call — Configurable
  • Reject Call — Configurable
  • Toggle Deafen — Configurable
  • Toggle Mute — Configurable
  • Toggle Input Mode — Configurable
  • Push to Talk — Configurable
Keyboard shortcuts

Get started

Your server. Your rules. Your conversations.

Download Now