diff --git a/GeoffreyApp/docs/source/bot_setup.rst b/GeoffreyApp/docs/source/bot_setup.rst index d4a8582..5c9d6f5 100644 --- a/GeoffreyApp/docs/source/bot_setup.rst +++ b/GeoffreyApp/docs/source/bot_setup.rst @@ -24,37 +24,14 @@ Installing GeoffreyBot From Source pip3 install -e . -Create Startup File -******************* +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. Below is an -example. +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 `__ -.. code-block:: python - - from GeoffreyBot import bot - - # Set discord_token to the token for the Discord bot - discord_token = "" - - # Set geoffrey_api_url to the base api url of the GeoffreyApp - # Example: - # https://test.zerohighdef.com/test/GeoffreyApp/api/ - geoffrey_api_url = "" - - # Set geoffrey_app_url to the base link of the url - # Example: - # If Geoffrey runs at https://24carrotcraft.com/whitelist/geoffrey/home/ - # geoffrey_app_url would be https://24carrotcraft.com - geoffrey_app_url = "" - - # Set geoffrey_token to the token generated by the GeoffreyApp - geoffrey_token = "" - - if __name__ == '__main__': - print("Starting bot and connecting to {}".format(geoffrey_base_link)) - bot.start_bot(discord_token=discord_token, - geoffrey_api_url=geoffrey_api_url, - geoffrey_api_token=geoffrey_token, - geoffrey_app_url=geoffrey_app_url) +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 `__