Skip to content

Simple webserver to view selfhosted modmail logs.

License

Notifications You must be signed in to change notification settings

Microsoft-community/logviewer

 
 

Repository files navigation

Modmail log viewer

A simple webserver to view your selfhosted modmail logs.

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 update the logviewer in your Heroku account whenever changes are made to this repo.

If you didn't fork this repo before

Fork the repo by clicking the Fork button at the top right of this page (must be on desktop site). Then on your Heroku account, go to the log viewer application, Deploy tab, and connect the repo named yourusername/logviewer. Do a manual deploy of the master branch.

If you forked this repo before

Click here to create a new pull request to your fork. Select compare across forks, make the base repository yourusername/logviewer and ensure the branch is set to master. Put any title you want and create the pull request. On the page that comes after this, merge the pull request.

You then want to go to your log viewer application in Heroku, connect your logviewer fork via the Deploy tab and deploy the master branch.

You can turn on auto-deploy for the master branch if you don't want to go through the process of logging into Heroku and deploying the branch every time changes to the repo are made in the future.

Discord Oauth2 setup

To enable discord oauth support in order to log in via discord to view logs, you will need to set up a few more environment variables.

  • GUILD_ID - the guild id of your modmail inbox server, this is required so the server can check if a user has a whitelisted role.
  • TOKEN - Token of your modmail bot, required for the same reason as above.
  • OAUTH2_CLIENT_ID - The id of your bot.
  • OAUTH2_CLIENT_SECRET - Get this from the general information section of your bot app in the discord dev portal.

  • OAUTH2_REDIRECT_URI - This will be equal to the url of your log viewer app + /callback e.g. https://logwebsite.com/callback. You will need to add this same url as a redirect url in the oauth2 section in the discord dev portal.

Now you need to set up users or roles to whitelist access to your logs, do this via the ?oauth whitelist @user/role command on your modmail bot.

This should enable whitelisted users to view logs while anyone else trying to access them will be rejected,

Contributing

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

About

Simple webserver to view selfhosted modmail logs.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 42.3%
  • HTML 31.8%
  • CSS 25.2%
  • Other 0.7%