Setup

1. Install node.js on your machine

Install node.js if you haven't already. You'll need this in order to run the logs viewer.

2. Edit the config file

1. Open the config.js in the logs viewer folder. If you don't have a code editor software such as Visual Studio Code, you can simply open the file with a text editor.
2. Configuration Variables

Key	Description	Required
databaseURI	Your MongoDB Database URI (e.g. mongodb+srv://Username:@modmail.mongodb.net/)	true
port	The port where modmail logs viewer will be hosted (this will enable the logs viewer)	leave it as default if port 3000 is available
clientId	Your Discord Application's Client ID/Application ID	false (require if oAuth2 is enabled)
clientSecret	Your Discord Applications's Client Secret	false (require if oAuth2 is enabled)
logsURI	Threads logging URI, matches the oAuth2's redirect URI (if enabled)	true
oAuth2	Enabled/Disable oAuth2	false
webhookURI	A Discord Webhook URI for logsviewer logging	false

3. Startup the logs viewer

After going through those necessary steps, its time to try if the logs viewer works. You can straight away open the start.bat file if you're on a Windows device. You should be able to startup the bot without opening start.bat, or if you're on a linux or macOS device:

The following assumes basic knowledge about using command line tools.

• Run npm ci in the logs viewer folder before first start up and after every update
• Run npm start in the logs viewer to start the bot