Initial commit

data/config_sample.json

@@ -0,0 +1,92 @@
+{
+	# Бэкэнд бота работает по редиске
+	"redis": {
+		# Если не задан, будет localhost
+		"server": "redis.tld",
+		
+		# 6379 if not set
+		"port": 6379,
+
+		# Канал, на котором работает msg router
+		"channel" : "misc"
+
+		# Канал, в который пишут другие модули бота сообщения для irc-модуля
+		"my_channel" : "irc"
+	},
+
+	# Фронт-энд бота
+	"irc": {
+		# Если не задан, будет localhost
+		"server": "irc.tld",
+
+		# 6667 обычно используется для незашифрованного соединения, 6697 - для шифрованного
+		# Если не задано - 6667
+		"port": 6667,
+
+		# Кому нахуй наужно это шифрование? выключено по-умолчанию.
+		# Пожалуйста, используйте шифрованные каналы связи в этих ваших интернетах!
+		"ssl": false,
+
+		# Не проверяем сертификаты по-умолчанию.
+		# Вам правда хочется всё это проверять?
+		"ssl_verify": false,
+
+		# Ник бота, желательно его зарегистрировать на стороне irc-сервера. Чтобы не угнали.
+		"nick": "aleesa",
+
+		# Имя пользователя (поле user в ирк-клиентах, а также username в sasl-авторизации)
+		"user": "aleesa",
+
+		# Пароль для авторизации у NickServ-а или с помощью sasl-а
+		# Авторизация не используется, если он пустой или не задан
+		"password": "secret",
+
+		# Если север умеет в sasl-авторизацию, то используем её.
+		"sasl": true,
+
+		# Ирк-каналы, к которым бот попробует присоединиться при старте
+		"channels": [
+			"#my_channel",
+			"#another_channel password"
+		],
+
+		"ratelimit": {
+			# Может быть none, simple_delay, token_bucket
+			"type": "simple_delay",
+
+			# Простая задержка между двумя последовательно отправляемыми сообщениями, измеряется в миллисекундах
+			# Если не задано, то 50мс; если менее 50мс, то 50мс (или 20 сообщений за секунду)
+			"simple_delay": 250,
+
+			# Более сложный алгоритм, применяется на libera.chat. За период времени expiration_time можно втолкнуть без ограничений
+			# не более size сообщений, после этого необходимо вталкивать не более limit в expiration_time сообщений. Если сообщения не
+			# поступали в течение expiration_time, то ограничение снимается.
+			"token_bucket": {
+				# Количество сообщений, по достижении которого начинает действовать ограничение
+				# Если не задано, то 5; если меньше 3, то 5
+				"size": 5,
+				# Количество сообщений в секунду, когда наступило ограничение
+				# Если не задано, то 1 (в секунду)
+				"limit": 2,
+				# Период времени в секундах, за который истекает ограничение
+				# Если не задан, то 2; если меньше 2, то 2
+				"expiration_time": 2
+			}
+		}
+	},
+
+	# Многословность логов. Если не задано, то info. Debug - ДЕЙСТВИТЕЛЬНО вербозный уровень логгирования.
+	"loglevel" : "info",
+
+	# Если не задан, логи идут в STDOUT
+	"log" : "/var/log/aleesa-irc-go/aleesa-irc-go.log",
+
+	# Должен быть установлен в какой-то символ - это символ-префикс, с которого начинаются команды бота
+	"csign" : "!",
+
+	# Будет 5, если не задан. Скорее всего вам не надо это менять.
+	"forwards_max" : 5,
+
+	# data_dir - каталог, в котором размещается бд с настройками бота, которые можно менять на лету через команду !admin
+	"data_dir" : "data"
+}