Skip to content

An external website that allows moderators and administrators to view past Modmail threads. It provides a convenient way for moderators to track previous conversations and helps them to maintain a record of user interactions.

License

Notifications You must be signed in to change notification settings

modmail-dev/logviewer

Repository files navigation

Modmail Log Viewer

A simple webserver to view your selfhosted modmail logs.

Deploy to Heroku Support Donate on Patreon Made with Python 3.7 Coding Style Black AGPL License

What is this?

In order for you to view your selfhosted logs, you have to deploy this application. Before you deploy the application, create a config var named MONGO_URI and put your MongoDB connection URI from the previous section into the value slot. Take the URL of this app after you deploy it and input it as a config var LOG_URL in the Modmail bot app.

Updating

You can automatically update the logviewer in your Heroku account whenever changes are made to this repo.

To enable autoupdates, fork this repo and install the Pull app in your fork. Then go to the Deploy tab in your Heroku account, select GitHub and connect your fork. Turn on auto-deploy for the master branch.

Self-Hosting Setup

There are a couple ways you can go about hosting the logviewer. Below is a simple set of instructions to get started!

First, I recommend setting up a vhost and reverse proxy via nginx for the log viewer. Otherwise you'll be accessing it from <IP_OF_VPS>:<LOGVIEWER_PORT> A Guide to setup a reverse proxy to help get started. Next, ensure you're running Python 3.9 or above A Quick Guide on how to do this, along with ensuring pip (On Ubuntu, generally sudo apt-get install python3-pip is sufficient) is installed as well.

Run the following: git clone https://github.com/kyb3r/logviewer cd logviewer python3 -m pip install pipenv cp .env.example .env

Edit the .env file and fill in your Mongo connection string. If you wish to customize the bind IP and port, you may do so, but I'll be referencing the default port below (8000)

pipenv install chmod +x logviewer.sh

Then to start the app, run ./logviewer.sh

The app will start by default listening on all interfaces, if unmodified running on port 8000. You can test this is working by navigating to <IP_OF_SERVER>:8000 and should be greeted with the Modmail Logviewer Main Page.

Discord OAuth2

Protecting your logs with a login (Discord Oauth2 support) is a premium feature, only available to Patrons.

Contributing

If you can make improvements in the design and presentation of logs, please make a pull request with changes.

About

An external website that allows moderators and administrators to view past Modmail threads. It provides a convenient way for moderators to track previous conversations and helps them to maintain a record of user interactions.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages