Skip to content

macbre/wiki-evolution

Repository files navigation

wiki-evolution

Node.js CI

Visualize evolution of your MediaWiki based site

Docker-based run

The easiest way to use this tool is via Docker:

docker pull ghcr.io/macbre/wiki-evolution:latest

docker run --name=wiki-evolution --rm -it -v $(pwd)/data:/tmp/wiki-evolution ghcr.io/macbre/wiki-evolution:latest bash

And then inside the container run:

nobody@3e68fe7411f8:/opt/wiki-evolution# ./bin/wiki-evolution.sh <wiki domain>

Gource log files and the rendered webm movie will be stored in the data/ directory on your host.

Requirements

  • MediaWiki-based wiki
  • gource for visualizing the history (will create a set of images)
  • ffmpeg to convert a set of images to a video file
  • xvfb to run gource in a virtual X server environment
  • nodejs with npm installed

Running

sudo apt-get install gource ffmpeg xvfb

should be enough on Debian-powered machines

For MacOS run:

brew install gource ffmpeg

How to install and run it?

npm install -g wiki-evolution

and then run wiki-evolution <wiki domain>, for instance:

wiki-evolution poznan.wikia.com
wiki-evolution fo.wikipedia.org

This will install wiki-evolution npm module globally and render the visualization for poznan.wikia.com and Faroese Wikipedia.

For large wikis with a long edits history you can include every N-th edit only:

EDITS_COMPRESSION=150 wiki-evolution muppet.wikia.com

This will include only the first, 150th, 300th, ... edit of each article.

Debug mode

Run the wiki-evolution script with DEBUG=1 env variable set to enable nodemw library debug mode:

DEBUG=1 EDITS_COMPRESSION=150 wiki-evolution muppet.wikia.com
...
debug:   API action: query
debug:   GET <http://muppet.wikia.com/api.php?action=query&prop=revisions&rvprop=ids%7Ctimestamp%7Csize%7Cflags%7Ccomment%7Cuser&rvdir=newer&rvlimit=5000&titles=X&continue=&format=json>
...

Genesis

Port of WikiEvolution extension developed during Wikia 2012 internship programme by @drzejzi. It's meant to be run standalone (i.e. outside MediaWiki stack) and generate wonderful videos of how your site evolved from its very beginning.

Examples

Screenshot 2021-10-28 at 12 25 07

Read more