UTRS 2.0

Getting UTRS2 working in a dev environment

Clone into a directory
composer install
cp .env.example .env
edit the DB details in .env
php artisan key:generate
php artisan migrate:fresh

The /public subdirectory is the webroot. You can either use php artisan serve to run a standalone webserver, or point your webserver of choice at /public

Configuring wikis

Currently, most details about supported wikis are stored in config/wikis.php, but a transition to storing them in the database is in progress. For this reason, you need to use php artisan utrs-maintenance:sync-wikis-to-database to synchronize changes in that file to the database for some details to work correctly.

Building frontend assets

The frontend is built using Bootstrap 4. It uses purgecss to remove unused classes to reduce bundle size. This can create complications for development.

First, install NPM dependencies using npm install. Then, you can use Laravel Mix (webpack wrapper) to build assets:

Use npm run watch to start Webpack mix in development watch mode. That mode does not use PurgeCSS and it re-builds all assets when it detects a change. This is most useful when working with JavaScript or when modifying the SCSS files.
Use npm run dev to do one build in the development mode. This mode does not use PurgeCSS. This is most useful when you are working on the frontend, as you have access to all classes Bootstrap has to offer.
Use npm run prod to do a production build. This build uses PurgeCSS and URL versioning. Due to legacy reasons a production build should be commited to the repository for pull requests. This may change soon, see issue #240.

Seeding

UTRS has a suite of seeds that can be used to automatically generate sample data for your development environment.

To reset your database, and create data based on seeds, you can always type

php artisan migrate:fresh --seed

Resetting your database will get rid of your user account and all of its permissions. You will find few .env variables to help with this:

# for seeding:
DEVELOPER_USER_NAME=""
DEVELOPER_USER_GRANT_ADMIN=""
DEVELOPER_USER_GRANT_TOOLADMIN=""
DEVELOPER_USER_GRANT_DEVELOPER=""

If you set DEVELOPER_USER_NAME to your user name, that user will automatically created. You can then set DEVELOPER_USER_GRANT_ADMIN and DEVELOPER_USER_GRANT_TOOLADMIN to "enwiki" and then you wll be granted admin and tooladmin access there. Finally, if you set DEVELOPER_USER_GRANT_DEVELOPER to true, you will receive the global developer permission which grants you full access to the interface.

Setting up MediaWiki integration for testing

API calls

You have a couple of options here. Either

Create a bot password for your own testing MediaWiki installation

Use Special:BotPasswords to create a bot password. If you have configured e-mail sending to mediawiki, access to that is useful.

In .env, set MEDIAWIKI_USERNAME to the bot password username and MEDIAWIKI_PASSWORD to the password. Also set WIKI_URL_GLOBAL, WIKI_URL_ENWIKI, and WIKI_URL_PTWIKI to be http://your-mediawiki/w/api.php.

Create a bot password on Beta Cluster

This is useful because Beta Cluster is really similar to beta. Use Special:BotPasswords on some wiki to create a bot password (they are global).

In .env, set MEDIAWIKI_USERNAME to the bot password username and MEDIAWIKI_PASSWORD to the password. Also set

WIKI_URL_GLOBAL=https://meta.wikimedia.beta.wmflabs.org/w/api.php
WIKI_URL_ENWIKI=https://en.wikipedia.beta.wmflabs.org/w/api.php
WIKI_URL_PTWIKI=https://es.wikipedia.beta.wmflabs.org/w/api.php # no ptwiki on betacluster, let's use eswiki instead

OAuth

You need a wiki with Extension:OAuth installed. It's easier if you use the same wiki used with API calls.

Use the following settings:

Protocol version: 1.0a
Callback URL: http://utrs.test/oauth/callback change this depending on your setup
"Allow consumer to specify a callback in requests and use "callback" URL above as a required prefix." should be yes
Types of grants being requested: "User identity verification only"

If you set it as for yourself only you don't need to get it approved.

Set up .env:

OAUTH_CALLBACK_URL="http://utrs.test/oauth/callback" # change this also depending on your setup

OAUTH_BASE_URL="https://meta.wikimedia.beta.wmflabs.org"
OAUTH_CLIENT_ID="some-client-id"
OAUTH_CLIENT_SECRET="some-client-secret"

Job executor (for production)

For this to work, you need to have your own urls set up for config/wikis.php
This application requires a job queue to verify blocks and do other critical and regualar tasks. Below is a guide to setting up:

Ensure jobs work with php artisan queue:work
Add the following block at /etc/systemd/system/utrs-jobrunner.service, example, replacing /path/tos:

DO NOT CHANGE ANY OF THESE VALUES EXCEPT THE PATHS

[Unit]
Description=UTRS job runner

[Service]
Restart=always
User=www-data
Group=www-data
ExecStart=/path/to/artisan queue:work
TimeoutStopSec=20s

[Install]
WantedBy=multi-user.target

sudo systemctl daemon-reload
sudo systemctl enable utrs-jobrunner.service
sudo systemctl start utrs-jobrunner.service

UTRS2/utrs