Open main menu

Extension:UrlShortener


MediaWiki extensions manual
OOjs UI icon advanced.svg
UrlShortener
Release status: stable
UrlShortener.png
Implementation Special page , API , MyWiki
Description Provides a basic URL shortening service
Author(s) Yuvipandatalk
Latest version Continuous updates
MediaWiki 1.25+
PHP 5.4+
Database changes Yes
License Apache License 2.0
Download
  • $wgUrlShortenerTemplate
  • $wgUrlShortenerDBName
  • $wgUrlShortenerDomainsWhitelist
Translate the UrlShortener extension if it is available at translatewiki.net
Check usage and version matrix.
Issues Open tasks · Report a bug

The UrlShortener extension provides a basic URL shortening service as a MediaWiki extension. It will require some changes to your web server's configuration to operate properly. It was originally designed to implement the URL Shortener RfC.

For user documentation, see m:Wikimedia URL Shortener.

InstallationEdit

  • If using Vagrant , install with vagrant roles enable urlshortener --provision
Manual installation
  • Download and place the file(s) in a directory called UrlShortener in your extensions/ folder.
To make //wiki.ext/r/foo work properly, you will need to set up rewrite rules for your webserver. Example rules for Apache are provided inside the extension.

ConfigurationEdit

LocalSettings.phpEdit

URL routing configuration

Configures the template to use when generating the shortened URL. Using this feature will require mod_rewrite (or an equivalent). If set to false (default), the short URLs will use the not-so-short /wiki/Special:UrlShortener/5234 since it will work regardless of web server configuration.

If you wanted your short URLs in the form of domain.org/r/5234, you would set:

$wgUrlShortenerTemplate = '/r/$1';
Short domain name

If you have a custom short domain name, you can set it by using:

$wgUrlShortenerServer = "short.wiki";

If set to false (default), it will use $wgServer.

Global database

Set this to the name of a database if you wish to use one central database for your wiki farm. If set to false (default), it will use the wiki's normal database.

$wgUrlShortenerDBName = false;

If the database is on an external cluster, you will also need to configure that.

$wgUrlShortenerDBCluster = false;
Allow arbitrary ports

By default, only URLs with ports 80 and 443 are accepted and are automatically removed. If your wiki is set up using a custom port, set this to true to allow shortening URLs that have arbitrary ports.

$wgUrlShortenerAllowArbitraryPorts = true
Whitelist regex

Configures the acceptable domains that users can submit links for. This is an array of regular expressions. If set to false (default), it will set up a whitelist for the current domain (using $wgServer).

$wgUrlShortenerDomainsWhitelist = false;

For example, to only whitelist links to wikipedia.org or wikimedia.org, we would use the following:

$wgUrlShortenerDomainsWhitelist = array(
	'(.*\.)?wikimedia\.org',
	'(.*\.)?wikipedia\.org',
);

If we wanted to whitelist any domain:

$wgUrlShortenerDomainsWhitelist = array( '.*' );
Whitelist documentation

To provide human-readable documentation of the whitelist, this is an array of the whitelisted domains that will be displayed on Special:UrlShortener.

If set to false (default), it will output a normalized version of $wgServer.

$wgUrlShortenerApprovedDomains = false;

If you only whitelisted wikipedia.org and wikimedia.org in the above example:

$wgUrlShortenerApprovedDomains = array(
	'*.wikimedia.org',
	'*.wikipedia.org',
);
Shortcode character set

If you want to customize the character set the shortcodes use, you can override this setting. If changed, any existing short URLs will go to the wrong destination.

$wgUrlShortenerIdSet = '23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz$';

The first character in the list is treated as a leading zero; no shortcodes beginning with that character will be created, and it is ignored when used at the start of the shortcode in a URL (e.g. https://w.wiki/22222222w is the same as https://w.wiki/w).

Read-only mode

Set $wgUrlShortenerReadOnly to true to prevent users from creating new short URLs. This is mainly intended as a hack while deploying to Wikimedia sites and will be removed once it is no longer needed.

VirtualHost or .htaccessEdit

To have truly short URLs, you will need to set up rewrite rules, using mod_rewrite or something similar. An example of what to put in your .htaccess file comes with the extension. If our template was set up to /r/$1, then we could use:

RewriteEngine On
RewriteRule ^r/(.*)$ /w/index.php?title=Special:UrlRedirector/$1 [PT]

If you are using nginx, you can add the following within a server { definition.

location ~ ^/r/(.*) {
	return 301 /w/index.php?title=Special:UrlRedirector/$1;
}

This assumes your $wgScriptPath is set to /w.

APIEdit

This extension provides the API module action=shortenurl to get the shortened url for a given url, creating it if does not exist already. See the API documentation here: https://meta.wikimedia.org/w/api.php?action=help&modules=shortenurl.

  • url - URL to shorten.

Response:

{
    "shortenurl": {
        "shorturl": "http://127.0.0.1:8080/s/3"
    }
}

See alsoEdit