Documentation + tools
List generated from folders in /docs.
README preview from GitHub (main / configured branch).
Modern IRC server written in Node.js combining the full functionality of UnrealIRCd and Anope IRC Services into a single unified system, with a web-based administration panel.
install.batchmod +x install.sh start.sh
./install.sh# 1. Install dependencies
npm install
# 2. Run interactive setup
npm run setup
# 3. Generate TLS certificates
npm run generate-cert
# 4. Start the server
npm startstart.bator
npm start./start.shor
npm startConfiguration is stored in CODE_0 in the project root. It is generated during setup but can be edited manually.
{
server: {
name: 'irc.kitsune.local', // Server hostname
network: 'KitsuneNet', // Network name
ports: [6667], // Plain IRC ports
tlsPorts: [6697], // TLS/SSL IRC ports
host: '0.0.0.0', // Bind address
maxClients: 1024, // Max concurrent connections
pingTimeout: 120, // Ping timeout (seconds)
pingInterval: 30, // Ping interval (seconds)
password: null, // Server-wide password (null = none)
},
tls: {
cert: './certs/server.crt', // TLS certificate path
key: './certs/server.key', // TLS private key path
},
opers: [
{
name: 'admin', // Oper username
password: 'password', // Oper password (bcrypt hash or plain)
host: '*@*', // Host mask restriction
flags: 'oOaANrRDKGZCcdkbBnmMSqtUTHW',
}
],
services: {
nickserv: { nick: 'NickServ', enabled: true },
chanserv: { nick: 'ChanServ', enabled: true },
memoserv: { nick: 'MemoServ', enabled: true },
operserv: { nick: 'OperServ', enabled: true },
botserv: { nick: 'BotServ', enabled: true },
hostserv: { nick: 'HostServ', enabled: true },
},
security: {
cloak: { enabled: true, key: 'random-key', prefix: 'kitsune' },
flood: { maxPerInterval: 20, interval: 10 },
throttle: { maxPerIP: 3, period: 60 },
requireSASL: false,
},
webPanel: {
enabled: true,
port: 8080,
host: '0.0.0.0',
jwtSecret: 'auto-generated',
},
database: {
path: './data/kitsune.db',
},
motd: [
'Welcome to KitsuneNet!',
'Powered by KitsuneIRC',
],
}Connect with any IRC client:
Open in browser: CODE_0
On first access, you'll be prompted to create an admin account.
/msg NickServ REGISTER <password> <email>/msg NickServ IDENTIFY <password>Or use SASL PLAIN in your client settings.
/msg ChanServ REGISTER <#channel>/oper <name> <password>/msg MemoServ SEND <nick> <message>/msg HostServ REQUEST <your.custom.host>/msg NickServ HELP
/msg ChanServ HELP
/msg MemoServ HELP
/msg OperServ HELP
/msg BotServ HELP
/msg HostServ HELPKitsuneIRC uses SQLite (via CODE_0) with WAL mode for optimal performance.
Database tables:
The database file is stored at CODE_0 by default.
| Port | Protocol | Description |
|---|---|---|
| 6667 | TCP | Plain IRC |
| 6697 | TCP+TLS | Secure IRC |
| 8080 | HTTP | Web admin panel |
All ports are configurable in CODE_0.
KitsuneIRC/
├── src/
│ ├── index.js # Entry point
│ ├── config/
│ │ └── ConfigManager.js # Configuration management
│ ├── database/
│ │ └── Database.js # SQLite database layer
│ ├── server/
│ │ ├── IRCServer.js # Core IRC server
│ │ ├── Client.js # Client connection handler
│ │ ├── Channel.js # Channel management
│ │ ├── CommandHandler.js # IRC command processing
│ │ └── ModeHandler.js # Mode processing
│ ├── services/
│ │ ├── ServiceManager.js # Service orchestration
│ │ ├── BaseService.js # Base service class
│ │ ├── NickServ.js # Nickname services
│ │ ├── ChanServ.js # Channel services
│ │ ├── MemoServ.js # Memo services
│ │ ├── OperServ.js # Operator services
│ │ ├── BotServ.js # Bot services
│ │ └── HostServ.js # vHost services
│ ├── utils/
│ │ ├── IRCUtils.js # IRC utilities & numerics
│ │ └── Logger.js # Logging utility
│ └── web/
│ ├── WebPanel.js # Express web server & API
│ └── public/
│ └── index.html # Admin panel SPA
├── scripts/
│ ├── setup.js # Interactive setup wizard
│ └── generate-cert.js # TLS certificate generator
├── config.js # Server configuration
├── package.json
├── install.bat # Windows installer
├── install.sh # Linux/macOS installer
├── start.bat # Windows start script
├── start.sh # Linux/macOS start script
└── README.mdMIT
KitsuneIRC is inspired by UnrealIRCd and Anope IRC Services, reimplemented from scratch in Node.js as a modern, unified IRC server.