Skip to content

Platform: Web Interface

Jump to bottom
toddrob edited this page Aug 12, 2020 · 9 revisions

By default the web interface listens on port 8087. Override this during startup with the -p command line argument (-p 80). Then set the port in the System Config page of the web interface. If using Docker, you do not need to change the port redball listens on. See Platform: Setup & Run with Docker for more information.

Access the web interface by navigating to http://localhost:8087, or whatever port you specified.

I highly recommend changing the default user id (admin) and password (redball) in System Config, especially if you plan to expose the web interface to the internet.

Bots

The bots/home page includes a list of configured bots with start/stop controls and status, as well as a tile to create a new bot. Available actions depend on the logged-in user's privileges. More details on the Bots: Setup, Configuration, and Running page.

System Config

The System Config page displays available system settings within the following categories: Web/Security, Logging, API, Bot Types, and Reddit Authorizations.

  • Web/Security
    • Authentication method, either none, basic, or form-based (default is form-based with username admin and password redball--be sure to change if you make redball internet-facing) -- see #13 if you intend to use none.
    • HTTP root for web interface - this should be the URL you use to access the web interface (including https if applicable), e.g. http://localhost:8087, or if you use a reverse proxy it might be something like https://redball.mydomain.com. This is important for reddit authorizations.
    • HTTP port for web interface
    • HTTP proxy support
    • HTTPS support
      • Port for HTTPS web interface (standard port is 443)
      • File paths to certificate, private key, and certificate chain (if applicable) should include escaped backspaces (\), e.g. c:\certs\cert.pem -> C:\certs\cert.pem.
      • Option to disable HTTP when HTTPS is enabled
  • Logging
    • Enable/disable logging to console and/or file
    • Log level for console and file
  • Users
    • Add/edit/delete users, including setting privileges, generating an API key, and changing password. More details on the Platform: Managing Users page
  • Bot Types
  • Reddit Authorizations

Logs

The Logs page displays a list of log files from the /logs directory, sorted into groups for system, webserver, and each bot. The filenames are links to the files, in case you find that more convenient than browsing to the /logs folder.

Logout / Change Password

The logged in user name will display at the top-right of the website. Click the wrench next to the user name to change the password. The default password for the admin user is redball.

Click the Logout link at the top-right of the website to log out; this will direct you back to the login page.

Clone this wiki locally