Skip to content

ToAruShiroiNeko/wikilabels

 
 

Repository files navigation

Wiki Labels

This package provides the components of a generalized labeling service for MediaWiki. There are two primary components, a user script to be used on MediaWiki and a flask server for the gadget to converse with.

Server

The flask server is intended to be hosted by a web server, but a dev server can be started locally with

wikilabels dev_server

Installation

Dependencies

Installation will require some additional packages to be available.

sudo apt-get install postgresql-server-dev-all postgresql libffi-dev npm g++ python3-dev libmemcached-dev

Database setup

You'll need to create a wikilabels user and database. Here's a sequence of commands that works on a fresh install of postgres (note that sudo rights will be required).

Create a wikilabels user

$ sudo useradd wikilabels

Switch to postgres user to run commands

$ sudo su postgres
$ psql
postgres=# CREATE USER wikilabels WITH PASSWORD 'something secure';
postgres=# CREATE DATABASE wikilabels;
postgres=# GRANT ALL PRIVILEGES ON DATABASE wikilabels to wikilabels;
postgres=# \q
$ exit

Switch to wikilabels user to load schema

$ sudo su wikilabels
$ psql

Copy-paste config/schema.sql into the command prompt.

Optionally, you can also load sample data into the database by copy-pasting config/schema-testdata.sql into the command prompt

Installing javascript dependencies

$ npm install codemirror jquery oojs oojs-ui strftime yamljs

Starting the dev server

$ wikilabels dev_server --config config-localdev.yaml

Gadget

  1. Go to one of the js subpages of your user page. You can choose a page such as these:
  1. Copy the following to the page you have chosen:
// [[File:User:EpochFail/WikiLabels.js]] (workaround for [[phab:T35355]])
mw.loader.load( '//labels.wmflabs.org/gadget/loader.js' );
  1. Clear the cache of your browser.

This will import a live copy of the javascript.

See also

About

A generalized labeling service for MediaWiki

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CSS 75.9%
  • JavaScript 19.4%
  • CoffeeScript 3.0%
  • Python 1.5%
  • Other 0.2%