benamaurer
/
minecraft_manager
forked from Minecraft/minecraft_manager
1
0
Fork 0
Code Pull Requests Activity
minecraft_manager/docs/source/django-settings.rst

66 lines
2.6 KiB
ReStructuredText
Raw Permalink Normal View History

Moved documentation into project
2018-10-13 01:58:33 +00:00
.. include:: common.rst
.. _django-settings:
Django Settings
===============
Required
--------
``MINECRAFT_BASE_DIR`` - The base location of your Spigot server. (The one with your server.jar)
``MCM_BASE_LINK`` - The base URL to your whitelist. e.g. http://localhost:8000/whitelist/
----
Optional
--------
``WINDOW_TITLE`` - The title of all MCM web app windows.
``DASHBOARD_TITLE`` - The header of the dashboard (probably the name of your server).
``BOT_DIR`` - The path to your bot directory.
Internalize Discord Bot (#31)
2019-08-30 18:03:12 +00:00
``DISCORD_BOT_TOKEN`` - The token to use to run the Discord bot. This must be generated by you in the Discord developer area.
Moved documentation into project
2018-10-13 01:58:33 +00:00
``DISCORD_PING_LIST`` - A list of Discord Role IDs to ping whenever certain messages are sent.
Internalize Discord Bot (#31)
2019-08-30 18:03:12 +00:00
``DISCORD_BOT_PREFIX`` - The prefix to use for Discord bot commands. Set to ``!`` by default.
``DISCORD_BOT_ROLES`` - A list of Discord Roles allowed to use the bot. If this list is empty, no one can use the bot!
``DISCORD_SUPERUSER_ROLES`` - A list of Discord Roles allowed to use the superuser commands.
``DISCORD_ERROR_USERS`` - A list of user IDs to send errors to.
``DISCORD_MCM_CHANNEL`` - The ID for the channel used for Applications, Tickets, and Warnings.
``DISCORD_NOTIFICATION_CHANNEL`` - The ID for the channel used for notifications.
Moved documentation into project
2018-10-13 01:58:33 +00:00
``DISCORD_INVITE`` - The invite code to your Discord, for after a player applies on the web form.
``DYNMAP_URL`` - The URL to your dynmap if you have one. Leave blank if you'd rather use a static background for web forms.
``DYNMAP_STATIC_URL`` - The URL to your static dynmap if you have one.
``WORLD`` - The name of your overworld. This is used by dynmap as well as statistics.
``WORLD_BORDER`` - The size of your world border. Used to generate a random location on the dynmap if used.
``PLUGIN_PORT`` - The port that's set in your plugin's config.yml
``GLOBAL_LOG`` - The path to your global chat log file. Assuming a normal install: os.path.join(MINECRAFT_BASE_DIR, 'plugins/MinecraftManager/logs/global.log')
``STAFF_LOG`` - The path to your staff chat log file. Assuming a normal install: os.path.join(MINECRAFT_BASE_DIR, 'plugins/MinecraftManager/logs/staff.log')
``SERVER_QUERY_IP`` - The full IP (and port) used to query your server. (This is used to get a player list)
``COREPROTECT_WEB_URL`` - The URL to your CoreProtect Web UI, if it exists.
``COREPROTECT_ACTIVITY_URL`` - The URL to your CoreProtect Activity Web UI, if it exists.
``CAPTCHA_SECRET`` - Your secret key used for reCAPTCHA
``STATS_FILTER`` - A python list of partial strings used to filter out stats. e.g. ``['broken', 'dropped', 'picked_up']`` to filter out broken, dropped and picked up stats