Skip to content

Server Configuration

Valerie Liu edited this page May 31, 2025 · 1 revision

⚠️ Warning: This more of a goal than actual documentation and may change without warning and be largely incorrect for a while, it is not recommended to follow this yet until v1.0 is released. This is, for the moment, somewhere to write down the goals that isn't the fleeting conversations in IRC, and which is too long-winded for an Issue.


How do I configure my ObsidianIRC Server?

ObsidianIRC Servers are proudly built on top of UnrealIRCd, the most widely deployed IRC server; and so you can configure the core of your server by checking out the official UnrealIRCd Configuration Documentation. UnrealIRCd configuration is very extensible, but it doesn't need to be extensive.

ObsidianIRC-specific configuration docs will be listed on this page.

What you'll need

  • The hosted version of ObsidianIRC (not the stand-alone client/app) which includes a server (UnrealIRCd).
  • SSH client
    • We recommend Command Prompt for Windows
    • We recommend Terminal for Linux
  • SFTP client (optional)
    • We recommend FileZilla for Windows
    • We recommend native SFTP in the File Explorer for Linux
  • UnrealIRCd Syntax Highlighter plugin for VSCode (optional)
  • The UnrealIRCd documentation to hand
  • Anywhere between 15 minutes and a few hours, depending on how deeply you want to fine-tune every aspect of your server.

IRCv3

Here is the Issue to keep track of what IRCv3 features ObsidianIRC supports

Clone this wiki locally