Running

insobot uses several environment variables for configuration (and a config.h for more advanced configuration)

The recommended way of running it is to make a copy of insobot.sh.example and edit it to set whichever address, port, nick, channels, etc, you want.

Some modules also have their own runtime configuration stored in the modules/data/ directory. See the File Formats page for details.

Environment Variables

Main

• IRC_SERV
  • server to connect to.
• IRC_USER
  • username for the server.
• IRC_CHAN
  • comma separated list of channels to join
• IRC_ADMIN
  • name of the main admin for the bot (that's you! (probably))
• IRC_PORT
  • port for the server (defaults to 6667)
• IRC_PASS
  • optional password if required by the server.
• IRC_NICKSERV_PASS
  • password to send to the "nickserv" user in an identify command, if desired.
• IRC_ENABLE_SSL
  • if set to "1", tells libircclient that the server/port specifies an IRC over SSL/TLS connection. (requires libircclient 1.8 with ssl enabled)

mod_twitch

• INSOBOT_TWITCH_CLIENT_ID
  • the client id from twitch when you register an application with them
• INSOBOT_TWITCH_TOKEN
  • an oauth token for an account associated with the bot instance, allows use of !title to change the title if the account is added by someone as an editor.

mod_linkinfo

• INSOBOT_TWITTER_TOKEN
  • a twitter application bearer token thing see this, used to expand tweets

mod_quotes

• INSOBOT_GIST_USER
  • username that the quotes gist will be stored as
• INSOBOT_GIST_TOKEN
  • access token for this username from here
• INSOBOT_GIST_ID
  • the id/hash of the gist to store quotes in. Easiest way is to manually make one and copy from the URL.
• INSOBOT_QUOTES_DEFAULT_CHAN
  • if you want the quote commands, when not given a channel, to act on a specific channel instead of the current one, set this to that channel.

mod_imagemacro

• INSOBOT_IMGUR_CLIENT_ID
  • client id for api.imgur.com
• INSOBOT_IMGMACRO_ALBUM_ID
  • id of an album to store the images (currently half implemented)
• INSOBOT_IMGMACRO_ALBUM_HASH
  • the "delete hash" that is returned when creating the album, used to add images to it.

miscellaneous

• INSOBOT_NO_FORK
  • if set, don't fork a child process (no crash-restarting or stdout timestamps). Useful for debugging.
• INSOBOT_NO_AUTO_RESTART
  • if set, wait for a key via getchar before reconnecting in the event of a disconnect instead of doing it automatically.
• IRC_IS_TWITCH
  • set this if you use a direct IP to connect to twitch IRC instead of irc.chat.twitch.tv. This lets mod_automod know it should use twitch's commands to kick people instead of the regular IRC way.