Log Viewer - BuiltByOtte Documentation

Requirements

Pterodactyl Panel v2.0 or newer (the extension system).
A Minecraft (Java) server, or any server that writes its logs to /logs or /crash-reports.
The user needs the server permission file.read.
Sharing a log needs outbound internet access from the Panel to api.mclo.gs.

Installation

The entire install happens in the Panel. There is nothing to upload to your nodes.

Step 1: Download the extension

Extract the product ZIP and keep both log-viewer-1.0.0.pteroext (the installable build) and log-viewer-source.zip (the editable source) if you want to customize the extension.

Step 2: Install in the Panel

Sign in to your Panel as an administrator.
Go to Admin → Extensions.
Click Install and upload the .pteroext file.
Toggle the extension on to enable it, then reload the page.

A Logs tab now appears in the sidebar of each server.

Alternative: install from the command line

php artisan p:extension:install log-viewer-1.0.0.pteroext --enable

Using the Log Viewer

Open a log

Open a server and click Logs in the server sidebar. The list on the left shows every log file from /logs and every crash report from /crash-reports, newest first. latest.log is always at the top and opens straight away. Older logs that Minecraft compressed to .log.gz are unpacked for you.

Search and filter

Type in the search box to show only the lines that contain your text. Matches are highlighted.
Choose Warnings and errors or Errors only to hide the normal lines. The counts are shown in the menu.
Errors are shown in red and warnings in yellow. Stack traces below an error are counted as part of that error.
Long logs scroll smoothly, and the view stays at the bottom so the newest lines are in sight.

Click Share to upload the log to mclo.gs. The link is copied to your clipboard so you can paste it in a support ticket or on Discord. mclo.gs hides IP addresses in shared logs.

Refresh and download

Refresh loads the latest version of the log and the file list. Download saves the log as a text file, unpacked if it was compressed.

Permissions

The Logs page requires file.read. Server owners and administrators normally have this permission; grant it in the server's User editor for sub users.

Managing the extension

Action	How
Disable without removing	Toggle the extension off, or `php artisan p:extension:disable log-viewer`
Update	Install the newer `.pteroext` over the top from the Extensions page
Remove	Click Remove on the Extensions page, or `php artisan p:extension:remove log-viewer`

Need Help?

Join our Discord Server and open a ticket for support.