Repository files navigation

1. Clone into a directory
2. composer install
3. cp .env.example .env
4. edit the DB details in .env
5. php artisan key:generate
6. php artisan migrate:fresh

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

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

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

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

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

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

Toreset 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 setDEVELOPER_USER_NAME to your user name, that user will automatically created. You can then setDEVELOPER_USER_GRANT_ADMIN andDEVELOPER_USER_GRANT_TOOLADMIN to"enwiki" and then you wll be granted admin andtooladmin access there. Finally, if you setDEVELOPER_USER_GRANT_DEVELOPER totrue, you will receive the globaldeveloper permission which grants you full access to the interface.

You have a couple of options here. Either

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

In.env, setMEDIAWIKI_USERNAME to the bot password username andMEDIAWIKI_PASSWORD to the password.Also setWIKI_URL_GLOBAL,WIKI_URL_ENWIKI, andWIKI_URL_PTWIKI to behttp://your-mediawiki/w/api.php.

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

In.env, setMEDIAWIKI_USERNAME to the bot password username andMEDIAWIKI_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

You need a wiki withExtension: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 setupOAUTH_BASE_URL="https://meta.wikimedia.beta.wmflabs.org"OAUTH_CLIENT_ID="some-client-id"OAUTH_CLIENT_SECRET="some-client-secret"

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:

1. Ensure jobs work with php artisan queue:work
2. 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=alwaysUser=www-dataGroup=www-dataExecStart=/path/to/artisan queue:workTimeoutStopSec=20s[Install]WantedBy=multi-user.target

3. sudo systemctl daemon-reload
4. sudo systemctl enable utrs-jobrunner.service
5. sudo systemctl start utrs-jobrunner.service