Erweiterung:UrlShortener
![]() Freigabestatus: stabil |
|
---|---|
![]() |
|
Einbindung | Spezialseite , API , MeinWiki |
Beschreibung | Provides a basic URL shortening service |
Autor(en) | YuviPandaDiskussion |
Letzte Version | Continuous updates |
MediaWiki | 1.25+ |
PHP | 5.4+ |
Datenbankänderungen | Ja |
Tabellen | urlshortcodes |
Lizenz | Apache License 2.0 |
Herunterladen | |
Hilfe | Help:Extension:UrlShortener/de |
|
|
Quarterly downloads | 57 (Ranked 116th) |
Public wikis using | 872 (Ranked 276th) |
Übersetze die UrlShortener-Erweiterung, wenn sie auf translatewiki.net verfügbar ist | |
Probleme | Offene Aufgaben · Einen Fehler melden |
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.
Installation
- Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens
UrlShortener
im Ordnerextensions/
ablegen. - Folgenden Code am Ende der
LocalSettings.php
einfügen:wfLoadExtension( 'UrlShortener' );
- Führe das Aktualisierungsskript aus, welches automatisch die notwendigen Datenbanktabellen erstellt, die diese Erweiterung braucht.
- Konfiguriere nach Bedarf.
- Adapt as required.
- Erledigt – Zu Special:Version in dem Wiki (bei Einstellung auf deutsch nach Spezial:Version) navigieren, um die erfolgreiche Installierung der Erweiterung zu überprüfen.
Vagrant-Installation:
- Wird Vagrant benutzt, ist mit
vagrant roles enable urlshortener --provision
zu installieren
//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.
Konfiguration
LocalSettings.php
- 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:UrlRedirector/5234
since it will work regardless of web server configuration.
If you want 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
.
- Globale Datenbank
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
- AllowedDomains 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 allowlist for the current domain (using $wgServer).
$wgUrlShortenerAllowedDomains = false;
For example, to only whitelist links to wikipedia.org or wikimedia.org, we would use the following:
$wgUrlShortenerAllowedDomains = array(
'(.*\.)?wikimedia\.org',
'(.*\.)?wikipedia\.org',
);
If we want to allow any domain:
$wgUrlShortenerAllowedDomains = array( '.*' );
- ApprovedDomains documentation
This is an array of the allowed domains but in a human-readable form. It will be displayed on Special:UrlShortener.
If set to false (default), it will output a normalized version of $wgServer.
$wgUrlShortenerApprovedDomains = false;
If you only allow 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. This should be done only once during the setup. Once changed thereafter, 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 oder .htaccess
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
.
API
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.
Antwort:
{
"shortenurl": {
"shorturl": "http://127.0.0.1:8080/s/3"
}
}
Siehe auch
Diese Erweiterung wird in einem oder mehreren Wikis von Wikimedia verwendet. Das bedeutet mit hoher Wahrscheinlichkeit, dass die Erweiterung stabil ist und gut genug funktioniert, um auf solch häufig besuchten Webseiten benutzt zu werden. Suche nach dem Erweiterungs-Namen in den Wikimedia CommonSettings.php und den InitialiseSettings.php-Konfigurations-Dateien, um zu nachzusehen, wo es installiert ist. Eine vollständige Liste der installierten Erweiterungen in einem bestimmten Wiki wird auf Special:Version im Wiki generiert und angezeigt. |
Diese Erweiterung ist in den folgenden Paketen und/oder WikiFarmen beinhalten: This is not an authoritative list. Some wiki farms/hosts may contain this extension even if they are not listed here. Always check with your wiki farms/hosts or bundle to confirm. |