README

Easily view your Flarum logfiles from within the admin interface.

This extension exposes the contents of files found in {flarum_install_dir}/storage/logs (including subdirectories) directly in the admin panel, without needing SSH or command-line access to your server.

Note: Be careful when sharing log snippets — they may contain sensitive data such as user details, email addresses, or internal paths.

Features

• View log files in the admin panel, including files in subdirectories (e.g. composer/)
• Download any log file directly from the admin panel
• Delete log files from the admin panel
• Auto-split large log files into smaller parts on a daily schedule (configurable, default 1 MB)
• Auto-purge old log files on a daily schedule (configurable, default 90 days)
• API access to list, retrieve, and delete log files from external systems

Screenshots

Settings

Two settings are available on the extension's settings page:

Both features rely on the Flarum scheduler being active.

Permissions

By default, only admins can access the log viewer. A View and manage logfiles permission is provided — you can grant it to a custom group if you need log access without full admin rights.

Never grant log access to regular users.

The permission can be set on the extension page or the global Permissions tab.

API Usage

Two API endpoints are provided to enable log retrieval from external systems.

All requests must be authenticated as a user with the manageLogfiles permission.

List log files

GET /api/logs

Returns a list of all log files. Supports sorting via the sort query parameter:

• -modified (default) — newest first
• modified — oldest first
• fileName
• size

Each item in the response includes a relativePath attribute (e.g. flarum.log or composer/output-2024-11-16.log) and an id field which is the base64url-encoded relative path.

Retrieve a log file

GET /api/logs/{id}

Returns the file's content. Use the id value from the list response.

Download a log file

GET /api/logs/download/{id}

Returns the raw file as an attachment.

Delete a log file

DELETE /api/logs/{id}

Installation

Requires Flarum 2.x.

composer require ianm/log-viewer

Updating

composer update ianm/log-viewer
php flarum cache:clear

Links

• Packagist
• GitHub
• Discuss