3.1 KiB
This getting started guide is for Operators -- that is, someone who wants to run the actual software for a ContentMod bot. If you are a Moderator check out the moderator getting started guide instead.
Table of Contents
- Installation
- Create a Reddit Client
- Create a Minimum Configuration
- Add a Bot to CM
- Access The Dashboard
- What's Next?
Installation
Follow the installation documentation. It is recommended to use Docker since it is self-contained.
Create a Reddit Client
Create a Minimum Configuration
Using the information you received in the previous step create a minimum file configuration save it as config.yaml somewhere.
Start ContextMod With Configuration
Local Installation
If you installed CM locally move your configuration file config.yaml to the root of the project directory (where package.json) is located.
From the root directory run this command to start CM
node src/index.js run
Docker Installation
If you installed CM using Docker make note of the directory you saved your minimum configuration to and substitute its full path for host/path/folder in the docker command show in the docker install directions
Add A Bot to CM
Once CM is up and running use the CM OAuth Helper to add authorize and add a Bot to your CM instance.
Access The Dashboard
Congratulations! You should now have a fully authenticated bot running on a ContextMod instance.
In order for your Bot to operate in a subreddit it must be a moderator in that subreddit. This may be your own subreddit or someone else's.
To monitor the behavior of bots running on your instance visit http://localhost:8085.
What's Next?
As an operator you should familiarize yourself with how the operator configuration you made works. This will help you understand how to get the most of your CM instance by leveraging the Cache and Database effectively as well as provide you will all possible options for configuring CM using the schema.
If you are also the moderator of the subreddit the bot will be running you should check out the moderator getting started guide.
You might also be interested in these quick tips for using the web interface