Extension:UrlShortener/nl

This page is a translated version of the page Extension:UrlShortener and the translation is 100% complete.
Niet te verwarren met Extension:ShortUrl.
MediaWiki Handleiding extensies
UrlShortener
Release status: stabiel
Implementatie Speciale pagina , API , MyWiki
Beschrijving Provides a basic URL shortening service
Auteur(s) YuviPandaoverleg
Laatste versie Continuous updates
MediaWiki 1.25+
PHP 5.4+
Database wijzigingen Ja
Tabellen urlshortcodes
Licentie Apache Licentie 2.0
Download
  • $wgUrlShortenerAllowArbitraryPorts
  • $wgUrlShortenerAllowedDomains
  • $wgUrlShortenerEnableQrCode
  • $wgUrlShortenerQrCodeShortenLimit
  • $wgUrlShortenerUrlSizeLimit
  • $wgUrlShortenerApprovedDomains
  • $wgUrlShortenerEnableSidebar
  • $wgUrlShortenerIdMapping
  • $wgUrlShortenerAltPrefix
  • $wgUrlShortenerTemplate
  • $wgUrlShortenerServer
  • $wgUrlShortenerReadOnly
  • $wgUrlShortenerIdSet
  • urlshortener-manage-url
  • urlshortener-create-url
  • urlshortener-view-log
Downloads kwartaal 34 (Ranked 103rd)
Publieke wiki's die het gebruiken 872 (Ranked 276th)
Vertaal de UrlShortener extensie indien beschikbaar op translatewiki.net
Problemen Open taken · Rapporteer een bug

De extensie UrlShortener zorgt voor een basisdienst voor het verkorten van een URL. Om dit goed te laten werken zijn er enkele wijzigingen in de configuratie van uw webserver nodig. Het is origineel ontworpen om het RFC URL Shortener te implementeren.

Voor instructies over het gebruiken van UrlShortener in Wikimedia projecten: Wikimedia URL Shortener.

Installatie

  • Download en plaats de bestanden in de map UrlShortener in de map extensions/.
    Ontwikkelaars en bijdragers van code moeten in plaats daarvan de extensie van Git installeren, met behulp van:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/UrlShortener
  • Voeg de volgende code onderaan het bestand LocalSettings.php toe:
    wfLoadExtension( 'UrlShortener' );
    
  • Voer het update script uit, dat automatisch de vereiste database-tabellen creëert die nodig zijn voor de extensie.
  • Als verplicht configureren.
  • De benodigde aanpassingen.
  •   Klaar – Navigeer naar Special:Version op de wiki om te controleren dat de extensie geïnstalleerd is.


Vagrant installatie:

  • Wanneer Vagrant gebruikt wordt, installeer door middel van vagrant roles enable urlshortener --provision
Om //wiki.ext/r/foo goed te laten werken dient u de 'rewrite rules' op uw webserver in te stellen. Voorbeelden hiervan voor Apache staan in de extensie.

Configuratie

LocalSettings.php

URL routing configuratie:

Configureert het te gebruiken sjabloon voor het genereren van de Korte URL. Om dit te kunnen gebruiken is mod_rewrite (of iets dergelijks) vereist. Indien de waarde false (standaard) is, dan zullen de korte URL's de 'not-so-short' /wiki/Special:UrlRedirector/5234 gebruiken omdat dat werkt ongeacht de webserver configuratie.

Als u korte URL's wilt in de vorm van domain.org/r/5234, dat stelt u in:

$wgUrlShortenerTemplate = '/r/$1';

Korte domeinnaam:

Als u een eigen korte domeinnaam heeft, dan kunt dat instellen met:

$wgUrlShortenerServer = "short.wiki";

Indien ingesteld op false (standaard), gebruikt het $wgServer .

Globale database:

Voer hier de databasenaam in die u als een centrale database voor uw farm wilt gebruiken. U kunt de standaardwaarde false gebruiken zodat de normale database van de wiki wordt gebruikt.

$wgUrlShortenerDBName = false;

Als de database op een extern cluster staat, dan moet u dat ook instellen.

$wgUrlShortenerDBCluster = false;

Willekeurige port toestaan:

Standaard worden alleen de port 80 en port 443 geaccepteerd en worden die automatisch verwijderd. Als uw wiki een andere port gebruikt, stel dit dan in op true, zodat een korte URL een willekeurige port kan hebben.

$wgUrlShortenerAllowArbitraryPorts = true

AllowedDomains reguliere expressie:

Configureert de domeinen waarvoor gebruikers links voor kunnen verzenden. Dit is een matrix met reguliere expressies. Indien de waarde false is (de standaardwaarde), dan wordt het een lijst met toegestane domeinen voor het huidige domein (met gebruik van $wgServer).

$wgUrlShortenerAllowedDomains = false;

Voorbeeld: om een witte lijst te maken met wikipedia.org en wikimedia.org, dan zouden we kunnen gebruiken:

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

Als we elk domein willen toestaan:

$wgUrlShortenerAllowedDomains = array( '.*' );

ApprovedDomains documentatie:

Dit een matrix met toegestane domeinen in een leesbaar formaat. Het wordt weergegeven op Special:UrlShortener.

Indien de waarde false is (de standaardwaarde), dan is het de genormaliseerde versie van $wgServer.

$wgUrlShortenerApprovedDomains = false;

Als u alleen wikipedia.org en wikimedia.org toelaat in het bovenstaande voorbeeld:

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

Shortcode karakterset:

Als u de karakterset wilt aanpassen die de shortcodes gebruiken, kunt u deze instelling overschrijven. Dit moet slechts één keer tijdens de instelling worden gedaan. Zodra deze later gewijzigd wordt, gaan alle bestaande korte URL's naar de verkeerde bestemming.

$wgUrlShortenerIdSet = '23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz$';

Het eerste teken in de lijst wordt behandeld als een voorloopnul; er worden geen shortcodes gemaakt die met dat teken beginnen en het wordt genegeerd wanneer het wordt gebruikt aan het begin van de shortcode in een URL (Voorbeeldː https://w.wiki/22222222w is hetzelfde als https://w.wiki/w).

Read-only mode:

Zet $wgUrlShortenerReadOnly op true om te voorkomen dat gebruikers nieuwe korte URL's maken. Dit is voornamelijk bedoeld als een hack tijdens het uitzetten op Wikimedia sites en zal worden verwijderd zodra het niet meer nodig is.

QR-codes:

MediaWiki-versie:
1.41

Vanaf versie 1.1.0 van UrlShortener kunt u het delen van een QR-code activeren. Dit heeft twee configuratie-instellingen. Eén is gewoon QR-code delen in te schakelen.

$wgUrlShortenerEnableQrCode = true;

Merk op dat nu ook $wgUrlShortenerEnableSidebar moet worden ingesteld als u wilt dat de link "QR-code downloaden" in de zijbalk verschijnt.

De link waar de QR-codes naar wijzen, wordt alleen verkort als die heel lang is. Dit komt omdat gebruikers liever een vertrouwd domein zien bij het scannen van een QR-code, maar als de URL te lang is dan zal de pixeldichtheid van de QR-code te moeilijk te scannen zijn. U kunt de lengte van URL's controleren die, wanneer ze worden overschreden, eerst worden verkort voordat u een QR-code maakt. Het aantal hier verwijst naar het aantal bytes, niet naar het aantal tekens.

$wgUrlShortenerQrCodeShortenLimit = 200;

VirtualHost of .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.

Antwoord:

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

Zie ook