Dashboard

This is the cog guide for the Dashboard cog. This guide contains the collection of commands which you can use in the cog. Through this guide, [p] will always represent your prefix. Replace [p] with your own prefix when you use these commands in Discord.

Note

Ensure that you are up to date by running [p]cog update dashboard. If there is something missing, or something that needs improving in this documentation, feel free to create an issue here. This documentation is generated everytime this cog receives an update.

About this cog:

Interact with your bot through a web Dashboard!

Installation guide: https://red-web-dashboard.readthedocs.io/en/latest ⚠️ This package is a fork of Neuro Assassin’s work, and isn’t endorsed by the Org at all.

Commands:

Here are all the commands included in this cog (19):

  • [p]dashboard

Get the link to the Dashboard.

  • [p]setdashboard

Configure Dashboard.

  • [p]setdashboard allinone <all_in_one>

Run the webserver in the bot process, without having to open another window. You have to install Red-Web-Dashboard in your bot venv with Pip and reload the cog.

  • [p]setdashboard allowunsecurehttprequests <allow_unsecure_http_requests>

Allow unsecure http requests. This is not recommended for production, but required if you can’t set up a SSL certificate.

  • [p]setdashboard defaultbackgroundtheme <default_background_theme>

Set the default Background theme of the dashboard.

  • [p]setdashboard defaultcolor <default_color>

Set the default Color of the dashboard.

  • [p]setdashboard defaultsidenavtheme <default_sidenav_theme>

Set the default Sidenav theme of the dashboard.

  • [p]setdashboard disabledthirdparties <disabled_third_parties>

The third parties to disable.

  • [p]setdashboard flaskflags <flask_flags>

The flags used to setting the webserver if all_in_one is enabled. They are the cli flags of reddash without –rpc-port.

  • [p]setdashboard metadescription <meta_description>

The website long description to use.

  • [p]setdashboard metaicon <meta_icon>

The website icon to use.

  • [p]setdashboard metatitle <meta_title>

The website title to use.

  • [p]setdashboard metawebsitedescription <meta_website_description>

The website short description to use.

  • [p]setdashboard modalconfig [confirmation=False]

Set all settings for the cog with a Discord Modal.

  • [p]setdashboard redirecturi <redirect_uri>

The redirect uri to use for the Discord OAuth.

  • [p]setdashboard resetsetting <setting>

Reset a setting.

  • [p]setdashboard secret [secret]

Set the client secret needed for Discord OAuth.

  • [p]setdashboard showsettings [with_dev=False]

Show all settings for the cog with defaults and values.

  • [p]setdashboard supportserver <support_server>

Set the support server url of your bot.

Installation

If you haven’t added my repo before, lets add it first. We’ll call it “AAA3A-cogs” here.

[p]repo add AAA3A-cogs https://github.com/AAA3A-AAA3A/AAA3A-cogs

Now, we can install Dashboard.

[p]cog install AAA3A-cogs dashboard

Once it’s installed, it is not loaded by default. Load it by running the following command:

[p]load dashboard

Further Support:

Check out my docs here. Mention me in the #support_other-cogs in the cog support server if you need any help. Additionally, feel free to open an issue or pull request to this repo.

Credits:

Thanks to Kreusada for the Python code to automatically generate this documentation!