Skip to content

Latest commit

 

History

History
45 lines (31 loc) · 2.07 KB

README.org

File metadata and controls

45 lines (31 loc) · 2.07 KB

Sophos

Sophos is an IRC bot implemented in Emacs-lisp. That means it runs inside Emacs!

Local Quickstart

Edit settings.env with your IRC and Redis details.

Run make run.

Docker Quickstart

Edit settings.env with your IRC details.

Run make docker-up.

Configuration

Sophos requires a number of environment variables to be set:

Environment VariableElisp VariableDefaultDescription
SOPHOS_HOSTsophos-hostirc.freenode.netthe ircd to connect to
SOPHOS_PORTsophos-port7000the ircd port to user
SOPHOS_SSLsophos-ssltset to ‘nil’ to disable
SOPHOS_SASLsophos-sasltset to ‘nil’ to disable
SOPHOS_NICKNAMEsophos-nicknamesophosnickname for the bot
SOPHOS_PASSWORDsophos-passwordpassword for nickserv
SOPHOS_ADMINSsophos-adminscsv list of admin nicknames
SOPHOS_CHANNELSsophos-channels##sophos-bots!csv list of channel-name!channel-password
SOPHOS_REDIS_HOSTsophos-redis-host127.0.0.1the redis server to use
SOPHOS_REDIS_PORTsophos-redis-port7000the port of the redis server
SOPHOS_REDIS_PASSWORDsophos-redis-passwordpassword for the redis server

.env Files

Sophos will always read in a .env file named settings.env

When run from make run it will also load local-settings.env

When run from Docker Compose it will load compose-settings.env

View settings.env for an example of the syntax in these files.

startup.el

Once running, Sophos will execute startup.el. View this file for an example of how to start Sophos with some plugins.