PHPackages                             teppokoivula/process-changelog - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. teppokoivula/process-changelog

ActivePw-module[Utility & Helpers](/categories/utility)

teppokoivula/process-changelog
==============================

ProcessChangelog is a ProcessWire CMS/CMF module for tracking changes (edits, additions, removals, etc.) of pages.

1.18.0(1y ago)83.2k↑126.7%2GPL-2.0-onlyJavaScriptPHP >=7.1

Since Jul 18Pushed 1y ago3 watchersCompare

[ Source](https://github.com/teppokoivula/ProcessChangelog)[ Packagist](https://packagist.org/packages/teppokoivula/process-changelog)[ Docs](https://github.com/teppokoivula/ProcessChangelog)[ GitHub Sponsors](https://github.com/teppokoivula)[ RSS](/packages/teppokoivula-process-changelog/feed)WikiDiscussions master Synced today

READMEChangelogDependencies (1)Versions (36)Used By (0)

Process Changelog Module
========================

[](#process-changelog-module)

Changelog module for ProcessWire CMS/CMF. Copyright (c) 2013-2022 Teppo Koivula

This module keeps track of changes (edits, additions, removals etc.) on your ProcessWire site. It is not intended as a version control solution: for that purpose there are other modules. The goal of this module is to provide admin users with a quick overview of sitewide changes.

Requirements
------------

[](#requirements)

- ProcessWire 3.x (at least last two master versions will be officially supported)
- PHP 7.1+

Automatic cleanup (highly recommended) requires that you install the LazyCron module. While LazyCron is bundled with the core package, it is not installed by default. Without automatic cleanup your database can eventually become slow as more and more changelog data is accumulated.

Installing
----------

[](#installing)

This module is installed just like any other ProcessWire module: copy or clone the directory containing this module to your /site/modules/ directory, log in, go to Admin > Modules, click "Check for new modules", and install "Changelog".

Alternatively you can get module files via Composer:

```
composer require teppokoivula/process-changelog

```

Process Changelog Hooks will be automatically installed with the main module, while installing Process Changelog RSS is completely optional: if installed, it provides you with a publicly viewable RSS feed of the changes to your site. More details under "Changelog RSS feed" heading.

How to use
----------

[](#how-to-use)

When you install this module, it creates a new page into the Admin called Changelog (Settings > Changelog). This page contains a list of changes to pages on the site since the moment this module was installed. By clicking the *more* link next to each row reveals more information about that particular change.

In order to access the Changelog page, users need to a) be authenticated and b) have a role with the "changelog" permission *or* have the superuser role. While the changelog permission will be added automatically when this module is installed, it needs to be given to any applicable roles manually.

### Changelog RSS feed

[](#changelog-rss-feed)

This module provides two types of RSS feeds: one that can be accessed only by authenticated users via the Changelog page (/setup/changelog/rss/), and other which can be enabled by installing the optional Process Changelog RSS module, typing in a key to it's config settings, and accessing the feed via URL such as this: .

Since the latter feed can be accessed via a public URL, please make sure that your key is as difficult to guess as possible (and never use key 1234567890). If you are unsure about whether you really need this feature, please leave the Process Changelog RSS module uninstalled.

### Schema update instructions

[](#schema-update-instructions)

This module updates the database schema automatically, but there may be cases where an update doesn't work as expected, particularly if you've got *a lot* of data in your database table(s).

If an error occurs, you can run schema update manually. Easiest way to trigger this would be creating a simple bootstrap script and running it on the server:

```