Преглед изворни кода

add comments explaining config file

tags/v0.1.0
Jeremy Latt пре 10 година
родитељ
комит
58f7d6dabf
1 измењених фајлова са 39 додато и 13 уклоњено
  1. 39
    13
      config.json

+ 39
- 13
config.json Прегледај датотеку

@@ -1,13 +1,39 @@
1
-{ "name": "irc.example.com",
2
-  "motd": "motd.txt",
3
-  "listeners": [
4
-      { "address": "localhost:7777" },
5
-      { "address": "[::1]:7777" } ],
6
-  "operators": [
7
-      { "name": "root",
8
-        "password": "JDJhJDEwJFRWWGUya2E3Unk5bnZlb2o3alJ0ZnVQQm9ZVW1HOE53L29nVHg5QWh5TnpaMmtOaEwya1Vl" } ],
9
-  "debug": {
10
-      "net": true,
11
-      "client": false,
12
-      "channel": false,
13
-      "server": false } }
1
+// Ergonomadic IRC Server Config
2
+// -----------------------------
3
+// Passwords are generated by `ergonomadic -genpasswd "$plaintext"`.
4
+// Comments are not allowed in the actual config file.
5
+{
6
+    // `name` is usually a hostname.
7
+    "name": "irc.example.com",
8
+
9
+    // The path to the MOTD is relative to this file's directory.
10
+    "motd": "motd.txt",
11
+
12
+    // PASS command password
13
+    "password": "JDJhJDA0JHBBenUyV3Z5UU5iWUpiYmlNMlNLZC5VRDZDM21HUzFVbmxLUUI3NTVTLkZJOERLdUFaUWNt",
14
+
15
+    // `listeners` are places to bind and listen for
16
+    // connections. http://golang.org/pkg/net/#Dial demonstrates valid
17
+    // values for `net` and `address`. `net` is optional and defaults
18
+    // to `tcp`.
19
+    "listeners": [ {
20
+        "address": "localhost:7777"
21
+    }, {
22
+        "net": "tcp6",
23
+        "address": "[::1]:7777"
24
+    } ],
25
+
26
+    // Operators for the OPER command
27
+    "operators": [ {
28
+        "name": "root",
29
+        "password": "JDJhJDA0JHBBenUyV3Z5UU5iWUpiYmlNMlNLZC5VRDZDM21HUzFVbmxLUUI3NTVTLkZJOERLdUFaUWNt"
30
+    } ],
31
+
32
+    // Global debug flags. `net` generates a lot of output.
33
+    "debug": {
34
+        "net": true,
35
+        "client": false,
36
+        "channel": false,
37
+        "server": false
38
+    }
39
+}

Loading…
Откажи
Сачувај