Geoffrey-Django/GeoffreyApp/docs/source/bot_setup.rst

.. _bot_setup:

******************
Geoffrey Bot Setup
******************

Setup
#####

Installing GeoffreyBot From Source
**********************************
1. Download GeoffreyBot by cloning it
::

    git clone https://git.canopymc.net/ZeroHD/Geoffrey-DiscordBot.git GeoffreyBot

2. Change directories into `GeoffreyBot`
::

    cd GeoffreyBot/

3. Install GeoffreyBot as a module
::

    pip3 install -e .

Create A Startup File
*********************
Since GeoffreyBot is installed as a module, a small bootstrap program must be used to launch it. The bootstrap program
must pass the discord token, the Geoffrey API token and the base url that the GeoffreyApp is running at. An example
can be found `here <https://git.canopymc.net/ZeroHD/Geoffrey-DiscordBot/src/branch/master/geoffrey_bot_start.py>`__

Create A Service File
*********************
In order to start and restart Geoffrey Bot automatically, a Systemd service can be created. An example service file can
be found `here <https://git.canopymc.net/ZeroHD/Geoffrey-DiscordBot/src/branch/master/geoffrey_bot.service>`__