conf/example.conf

   1 # synarere example configuration.
   2 # This configuration is straight forward.
   3
   4 # module: Load modules.
   5 # You may specify multiple 'module' blocks.
   6 #
   7 # module:
   8 #       name = path/to/file.py
   9
  10 # network: Networks to connect to.
  11 # You may specify multiple 'network' blocks.
  12 network:
  13         # id: The name of the network.
  14         # This can be anything you wish.
  15         id = Testnet
  16
  17         # address: The address of the server.
  18         # IPv4/6 IP addresses are supported.
  19         address = muffinpimp.net
  20
  21         # port: The port to connect on.
  22         port = 6668
  23
  24         # nick: Our nick to use.
  25         nick = synarere
  26
  27         # ident: Our user (ident) to use.
  28         ident = synarare
  29
  30         # gecos: Our GECOS (real name) to use.
  31         gecos = Ab insidiis diaboli, libera nos, Domine.
  32
  33         # pass: If this server requires a password, specify it here.
  34         # Comment this out if you do not need it.
  35         # pass = lolcake
  36
  37         # chans: The channels to join.
  38         # You may specify multiples by using a comma.
  39         chans = #test
  40
  41         # recontime: When the connection is lost, reconnect in 'x' amount of seconds.
  42         # Optional.
  43         # recontime = 30
  44
  45         # trigger: Trigger used for channel commands (not chanme)
  46         trigger = .
  47
  48 # logger: Logs messages to a file.
  49 logger:
  50         # path: The path to the logfile.
  51         path = etc/synarere.log
  52
  53         # level: The verbosity level of the log.
  54         # Valid options are: info, warning, error, critical, debug.
  55         level = debug
  56
  57         # max_size: The file size (in kilobytes) before the log is rotated.
  58         # If set to 0, the log will never rotate.
  59         max_size = 100
  60
  61         # max_logs: The maximum number of rotated logs to keep around.
  62         # If set to 0, unlimited number of logs will be kept.
  63         max_logs = 5
  64
  65         # format: If you know how to manipulate Python's logger module's formatting,
  66         # then feel free to change this to whatever you want. If you don't, do not touch this.
  67         # However, some examples are:
  68         #
  69         # Liberal: [%(asctime)s] %(message)s
  70         # Verbose: [%(asctime)s] -- %(levelname)s(%(module)s:%(lineno)s): %(message)s
  71         # Medium: [%(asctime)s] -- %(levelname)s: %(message)s
  72         format = [%(asctime)s] -- %(levelname)s: %(message)s
  73
  74         # stream_format: Same as 'format', except this is used when we are in
  75         # nofork mode.
  76         stream_format = [%(asctime)s] -- %(levelname)s: %(message)s
  77
  78 # options: Defines various options for synarere.
  79 options:
  80         # pidfile: The file to write the PID to.
  81         pidfile = etc/synarere.pid
  82
  83         # tbfile: The file to write the tracebacks to.
  84         tbfile = etc/synarere.tb
  85
  86         # irc_cmd_thread: When dispatching raw IRC commands, such as
  87         # PRIVMSG or MAP or something else, should we dispatch on a thread?
  88         # NOTE: This is generally useless, but if you want it so be it.
  89         # irc_cmd_thread = False
  90
  91         # chan_cmd_thread: When dispatching channel commands, should we
  92         # dispatch it on a thread? This is generally a good idea to handle multiple people.
  93         # chan_cmd_thread = True
  94
  95         # chanme_cmd_thread: When dispatching channel me commands, should we dispatch
  96         # it on a thread? REMEMBER: chan_cmd's are virtually the same as chanme_cmd's,
  97         # So if you have that threaded, thread this to.
  98         # chanme_cmd_thread = True
  99
 100         # priv_cmd_thread: When dispatching private messages to users, should we dispatch
 101         # it on a thread? This has the same reasoning as the former options.
 102         # priv_cmd_thread = True
 103
 104         # ctcp_cmd_thread: When dispatching CTCP commands to channels or users, should we
 105         # dispatch it on a thread? This is generally useless.
 106         # ctcp_cmd_thread = False