context-mod/docs/operator/installation.md

Installation

In order to run a ContextMod instance you must first you must install it somewhere.

ContextMod can be run on almost any operating system but it is recommended to use Docker due to ease of deployment.

Docker (Recommended)

PROTIP: Using a container management tool like Portainer.io CE will help with setup/configuration tremendously.

Dockerhub

An example of starting the container using the minimum configuration with a configuration file:

• Bind the directory where your config file, logs, and database are located on your host machine into the container's default DATA_DIR by using -v /host/path/folder:/config
• Expose the web interface using the container port 8085

docker run -d -v /host/path/folder:/config -p 8085:8085 foxxmd/context-mod

The location of DATA_DIR in the container can be changed by passing it as an environmental variable EX -e "DATA_DIR=/home/abc/config

Linux Host

NOTE: If you are using rootless containers with Podman this DOES NOT apply to you.

If you are running Docker on a Linux Host you must specify user:group permissions of the user who owns the configuration directory on the host to avoid docker file permission problems. These can be specified using the environmental variables PUID and PGID.

To get the UID and GID for the current user run these commands from a terminal:

• id -u -- prints UID
• id -g -- prints GID

docker run -d -v /host/path/folder:/config -p 8085:8085 -e PUID=1000 -e PGID=1000 foxxmd/context-mod

Locally

Requirements:

• Typescript >=4.3.5
• Node >=16
  • NPM >=8 (usually bundled with Node)

Clone this repository somewhere and then install from the working directory

git clone https://github.com/FoxxMD/context-mod.git .
cd context-mod
npm install
tsc -p .

An example of running CM using the minimum configuration with a configuration file:

node src/index.js run

Heroku Quick Deploy

NOTE: This is still experimental and requires more testing.

This template provides a web and worker dyno for heroku.

• Web -- Will run the bot and the web interface for ContextMod.
• Worker -- Will run just the bot.

Be aware that Heroku's free dyno plan enacts some limits:

• A Web dyno will go to sleep (pause) after 30 minutes without web activity -- so your bot will ALSO go to sleep at this time
• The Worker dyno will not go to sleep but you will NOT be able to access the web interface. You can, however, still see how Cm is running by reading the logs for the dyno.

If you want to use a free dyno it is recommended you perform first-time setup (bot authentication and configuration, testing, etc...) with the Web dyno, then SWITCH to a Worker dyno so it can run 24/7.