Skip to content

Document theflarum/audit extension (1.x)#535

Open
imorland wants to merge 1 commit into
mainfrom
im/audit-extension-docs
Open

Document theflarum/audit extension (1.x)#535
imorland wants to merge 1 commit into
mainfrom
im/audit-extension-docs

Conversation

@imorland

Copy link
Copy Markdown
Member

Adds documentation for the first-party flarum/audit extension, in the 1.x version (versioned_docs/version-1.x).

The page covers:

  • Requirements (JSON column / MySQL 5.7.8+ / MariaDB 10.2.7+), installation, and the upgrade path from the KILOWHAT audit extensions (composer replace and the in-place kilowhat_audit_logaudit_log table rename).
  • The flarum-audit.view and flarum-audit.viewLimited permissions and the limited-access settings.
  • Browsing the log, the search gambits (action, actor, user, client, discussion, ip) with comma/negation syntax, filter chips and autocomplete.
  • The optional IP country indicator via fof/geoip.
  • Anatomy of an entry, including the queued-job IP/actor caveat.
  • Removing data with audit:clear --reset / --before.
  • The full list of logged actions across core and the bundled first-party integrations.
  • A note that the third-party integrations (FoF, ClarkWinkelmann) are currently bundled but intended to move into those extensions via the public extender API.
  • A developer section for the public Flarum\Audit\Extend\Audit extender.

Registers the page in the 1.x guide sidebar under Management.

Documents the extension added in flarum/framework#4704.

Add a dedicated page for the first-party flarum/audit extension covering
permissions, browsing and search, the optional fof/geoip country indicator,
data removal, the full list of logged actions, and the public
Flarum\Audit\Extend\Audit extender for adding integrations. Register the
page in the 1.x guide sidebar.
@imorland imorland changed the title Document the Audit extension (1.x) Document theflarum/audit extension (1.x) Jun 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant