diff --git a/config.json b/config.json index d33117ab..b607611a 100644 --- a/config.json +++ b/config.json @@ -1,13 +1,39 @@ -{ "name": "irc.example.com", - "motd": "motd.txt", - "listeners": [ - { "address": "localhost:7777" }, - { "address": "[::1]:7777" } ], - "operators": [ - { "name": "root", - "password": "JDJhJDEwJFRWWGUya2E3Unk5bnZlb2o3alJ0ZnVQQm9ZVW1HOE53L29nVHg5QWh5TnpaMmtOaEwya1Vl" } ], - "debug": { - "net": true, - "client": false, - "channel": false, - "server": false } } +// Ergonomadic IRC Server Config +// ----------------------------- +// Passwords are generated by `ergonomadic -genpasswd "$plaintext"`. +// Comments are not allowed in the actual config file. +{ + // `name` is usually a hostname. + "name": "irc.example.com", + + // The path to the MOTD is relative to this file's directory. + "motd": "motd.txt", + + // PASS command password + "password": "JDJhJDA0JHBBenUyV3Z5UU5iWUpiYmlNMlNLZC5VRDZDM21HUzFVbmxLUUI3NTVTLkZJOERLdUFaUWNt", + + // `listeners` are places to bind and listen for + // connections. http://golang.org/pkg/net/#Dial demonstrates valid + // values for `net` and `address`. `net` is optional and defaults + // to `tcp`. + "listeners": [ { + "address": "localhost:7777" + }, { + "net": "tcp6", + "address": "[::1]:7777" + } ], + + // Operators for the OPER command + "operators": [ { + "name": "root", + "password": "JDJhJDA0JHBBenUyV3Z5UU5iWUpiYmlNMlNLZC5VRDZDM21HUzFVbmxLUUI3NTVTLkZJOERLdUFaUWNt" + } ], + + // Global debug flags. `net` generates a lot of output. + "debug": { + "net": true, + "client": false, + "channel": false, + "server": false + } +}