URL: Votre url courte personnalisée

A propos de YOURLS

Qu'est-ce que YOURLS

YOURLS signifie Votre propre URL courte. C'est un petit ensemble de scripts PHP qui vous permettra d'exécuter votre propre service de raccourcissement d'URL (à la TinyURL ou bitly).

Exécuter votre propre raccourcisseur d'URL est amusant, geek et utile: vous possédez vos données et ne dépendez pas de services tiers. C'est également un excellent moyen d'ajouter une marque à vos URL courtes, au lieu d'utiliser le même raccourcisseur d'URL public que tout le monde utilise.

YOURLS les caractéristiques

• Logiciel Gratuit et Open Source.
• Privé (vos liens seulement) ou Publique (tout le monde peut créer des liens courts, très bien pour de l'intranet).
• Mot clé URL séquentiel ou personnalisé.
• Pratique bookmarklets pour raccourcir et partager facilement des liens.
• Impressionnante Statistiques: rapports de clics, historiques, suivi des référents, géo-localisation des visiteurs.
• Interface soigné en Ajax.
• Trés bon Plugin avec une architecture pour implémenter facilement de nouvelles fonctionnalités.
• Développeur cool de l'API.
• Soutien complet de jsonp.
• Trés simple à installer.
• Exemples de fichiers pour créer votre propre interface publique et plus.

Captures d'écrans

Télécharger

Télécharger YOURLS chez Github.

Vous pouvez suivre le développement de YOURLS' sur le commit history et obtenir les développements en cours.

Crédits

YOURLS est fait par des personnes serieuses.

Restez à jour: suivez @yourls, @ozh (développeur principal) et lire la documentaion officiel sur le Blog de YOURLS.

Nouvelle installation

1. Décompressez l'archive YOURLS dans votre disque dur.
2. Renommer user/config-sample.php en user/config.php.
3. Editer user/config.php avec notepad++ et remplissez les paramètres requis.
4. Téléverser les fichiers décompressés dans le repertoire public_html ou www sur votre serveur.
5. Créer une nouvelle base de données (voir Configuration – vous pouvez également utiliser une BD existante).
6. Pointer sur cette adressse http://votre-propre-domaine.fr/admin/.

Guide d'installation

1. - Comment installer YOURLS sur Ubuntu 14.04 (Guide non officiel).


2. - Comment installer YOURLS sur CentOS 7 (Guide non officiel).


3. - Comment installer YOURLS sur un hébergement partagé (cPanel) (Guide non officiel).

Upgrade

1. Sauvegardez la base de données!
2. Décompressez l'archive YOURLS.
3. Téléverser les fichiers dans votre serveur, en écrasant votre installation existante.
4. Pointez votre navigateur vers http://votre-propre-domaine.fr/admin/.
5. Astuce: vous pouvez maintenant remplacer votre config.php dans le repertoire /user.

Mise à niveau depuis YOURLS 1.3 ou plus

1. Sauvegardez la base de données!
2. Faites une copie de votre config.php
3. Supprimer tous les fichiers, y compris .htaccess dans le répertoire racine de YOURLS
4. Décompressez l'archive YOURLS dans votre disque dur, et téléverser les fichiers sur votre FTP.
5. Renommer config-sample.php en config.php et remplissez avec vos infos. Ne commencez pas avec votre ancien fichier de configuration, utilisez le nouveau fichier exemple de configuration.
6. Dans votre nouveau config.php, ajouter le defines pour YOURLS_DB_TABLE_URL et YOURLS_DB_TABLE_NEXTDEC reportez-vous à votre fichier de configuration précédent.
7. Pointez votre navigateur vers http://votre-propre-domaine.fr/admin/ et suivez les instructions.
8. Après la mise à niveau, bien supprimer le YOURLS_DB_TABLE_NEXTDEC dans votre fichier de configuration.

Configuration (dans user/config.php)

Paramètres MySQL

• YOURLS_DB_USER
  Votre nom d'utilisateur MySQL
  Example: define( 'YOURLS_DB_USER', 'jfr' );
• YOURLS_DB_PASS
  Votre mot de passe MySQL
  Example: define( 'YOURLS_DB_PASS', 'MyS421LknH0rd' );
• YOURLS_DB_NAME
  Le nom de la base de données
  Example: define( 'YOURLS_DB_NAME', 'yourls' );
• YOURLS_DB_HOST
  L'hôte de la base de données
  Example: define( 'YOURLS_DB_HOST', 'localhost' );
• YOURLS_DB_PREFIX
  Le préfixe du nom pour toutes les tables dont YOURLS aura besoin
  Example: define( 'YOURLS_DB_PREFIX', 'yourls_' );

Options du site

• YOURLS_SITE
  Adresse de votre nom de domaine (la plus courte possible), sans slash, et en minuscule. Si vous choisissez la version non-www de votre domaine, n'utilisez pas la version www dans votre navigateur (et vice-versa)
  Example: define( 'YOURLS_SITE', 'http://pourvoustous.fr/url' );
• YOURLS_HOURS_OFFSET
  Décalage GMT du fuseau horaire
  Example: define( 'YOURLS_HOURS_OFFSET', '-5' );
• YOURLS_PRIVATE
  Privé signifie que la zone d'administration sera protégée avec login / pass comme défini ci-dessous. Voir Private or Public for more.
  Example: define( 'YOURLS_PRIVATE', 'true' );
• YOURLS_UNIQUE_URLS
  Autoriser plusieurs URL courtes pour une même URL longue
  Mis à true pour autoriser une seule paire de shortURL / longURL (comportement YOURLS par défaut), ou false pour permettre la création de plusieurs URL courtes pointant vers la même URL longue (comme le fait bit.ly)
  Example: define( 'YOURLS_UNIQUE_URLS', 'true' );
• YOURLS_COOKIEKEY
  Un hachage secret aléatoire utilisé pour crypter les cookies. Vous n'avez pas à vous en souvenir, à le rendre long et compliqué. Astuce: générer en un unique à http://yourls.org/cookie
  Example: define( 'YOURLS_COOKIEKEY', 'qQ4KhL_pu|s@Zm7n#%:b^{A[vhm' );
• yourls_user_passwords
  Une liste des noms d'utilisateurs) et des mots de passe) autorisés à accéder au site si privé
  Les mots de passe peuvent être soit en texte brut, soit cryptés: voir http://yourls.org/userpassword pour plus d'informations.
  Example: 'jfr' => 'monmotdepasse'

Paramètres du raccourcis des URL

• YOURLS_URL_CONVERT
  URL shortening method: base 36 or 62. See FAQ for more explanations
• yourls_reserved_URL
  Une liste de mots-clés réservés qui ne seront pas utilisés comme URL courtes. Définir ici les mots clés négatifs, indésirables ou potentiellement trompeurs
  Example: 'porn', 'faggot', 'sex', 'nigger', 'fuck', 'cunt', 'dick'

Paramètres optionnels

• YOURLS_PRIVATE_INFOS
  If YOURLS_PRIVATE est réglé sur true, vous pouvez toujours rendre les pages statistiques publiques. Pour ce faire, définissez avec:
  define('YOURLS_PRIVATE_INFOS', false);
• YOURLS_PRIVATE_API
  If YOURLS_PRIVATE est réglé sur true, vous pouvez toujours rendre votre API publique. Pour ce faire, définissez avec:
  define('YOURLS_PRIVATE_API', false);
• YOURLS_NOSTATS
  If YOURLS_NOSTATS est réglé sur true, les redirections ne seront pas enregistrées et il n'y aura pas de statistiques disponibles.
  

Réglages avancés

• YOURLS recherchera l'extension MySQL PDO, MySQLi ou MySQL, dans cet ordre. Si vous souhaitez forcer l'utilisation d'une extension particulière, ajoutez la ligne suivante à votre config.php:
  define( 'YOURLS_DB_DRIVER', 'mysqli' );
• Vous pouvez installer YOURLS derrière un pare-feu ou un proxy: voir Support de proxy
• Le fichier includes/load-yourls.php contient un peu plus de paramètres non documentés mais explicites et commentés. Ajoutez-les à votre propre config.php si vous savez ce que vous faites.

Plugins for YOURLS

Plugins?

Plugins are additional PHP scripts that extend the functionalities or features of YOURLS. The core of YOURLS is designed to be as light as possible and avoid bloat (implementing functions not everybody needs) and to allow for easy customization.

Using the plugin architecture, you can add new features to YOURLS without having to modify core files. This way, your changes won't be lost when you upgrade your YOURLS installation and you can easily activate and deactivate a plugin from the admin interface.

There's a growing number of plugins available: check the Plugin list.

Documentation

Several sample plugins are included in the archive. Read the source and learn the concept. It's easy and fun!

Check the plugin API documentation to learn more

YOURLS' API

Features

• Generate or get existing short URLs, with sequential or custom keyword
• Get some statistics about your links: top clicked links, least clicked links, newest links
• Output format: JSON, XML, or simple raw text
• Authentify either with login/password or using a secure passwordless mechanism

Usage

You need to send parameters to http://your-own-domain-here.com/yourls-api.php either via GET or POST (remember to URL encode parameters if via GET). These parameters are:

• A valid username / password pair, or your signature (see Passwordless API requests)
• The requested action: "shorturl" (get short URL for a link), "expand" (get long URL of a shorturl), "url-stats" (get stats about one short URL), "stats" (get stats about your links) or "db-stats" (get global link and click count)
• With action = "shorturl" :
  • the url to shorten
  • optional keyword and title for custom short URLs
  • output format: either "jsonp", "json", "xml" or "simple"
• With action = "expand" :
  • the shorturl to expand (can be either 'abc' or 'http://site/abc')
  • output format: either "jsonp", "json", "xml" or "simple"
• With action = "url-stats" :
  • the shorturl for which to get stats (can be either 'abc' or 'http://site/abc')
  • output format: either "jsonp", "json" or "xml"
• With action = "stats" :
  • the filter: either "top", "bottom" , "rand" or "last"
  • the limit (maximum number of links to return)
  • output format: either "jsonp", "json" or "xml"
• With action = "db-stats" :
  • output format: either "jsonp", "json" or "xml"

Sample requests

Example of a GET request with Javascript (using jQuery) to shorten a URL

var api_url  = 'http://sho.rt/yourls-api.php';
var response = $.get( api_url, {
    username: "your_username",
    password: "your_password",
    action:   "shorturl",
    format:   "json",
    url:      "http://ozh.org/"
    },
    // callback function that will deal with the server response
    function( data) {
        // for instance, return short URL
        return data.shorturl;
    }
);

Example of a POST request with PHP to expand a short URL

<?php
$username = 'your_username';
$password = 'your_password';
$api_url =  'http://sho.rt/yourls-api.php';

// Init the CURL session
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $api_url);
curl_setopt($ch, CURLOPT_HEADER, 0);            // No header in the result
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // Return, do not echo result
curl_setopt($ch, CURLOPT_POST, 1);              // This is a POST request
curl_setopt($ch, CURLOPT_POSTFIELDS, array(     // Data to POST
        'shorturl' => 'ozh',
        'format'   => 'json',
        'action'   => 'expand',
        'username' => $username,
        'password' => $password
    ));

// Fetch and return content
$data = curl_exec($ch);
curl_close($ch);

// Do something with the result. Here, we echo the long URL
$data = json_decode( $data );
echo $data->longurl;

Sample returns

Sample return in JSON format for the shorturl action

{
  "url": {
    "keyword": "ozh",
    "url": "http:\/\/ozh.org",
    "title": "Ozh RICHARD \u00ab ozh.org",
    "date": "2014-10-24 16:01:39",
    "ip": "127.0.0.1"
  },
  "status": "success",
  "message": "http:\/\/ozh.org added to database",
  "title": "Ozh RICHARD \u00ab ozh.org",
  "shorturl": "http:\/\/sho.rt\/1f",
  "statusCode": 200
}

Sample return in XML format for the expand action

<result>
    <keyword>ozh</keyword>
    <shorturl>http://sho.rt/ozh</shorturl>
    <longurl>http://ozh.org/</longurl>
    <message>success</message>
    <statusCode>200</statusCode>
</result>

Sample file

There's a sample PHP file included that serves as an example on how to play with the API

Expand the API

You can easily implement custom API actions with a plugin. See the plugin list for examples.

FAQ

Server requirements

1. A server with mod_rewrite enabled
2. At least PHP 5.3
3. At least MYSQL 5
4. Note: YOURLS can also run on Nginx and Cherokee

Server recommendations

• PHP CURL extension installed if you plan on playing with the API

Limitations

• Maximum length of custom keyword is 200 characters
• That makes about 8 sexdecillions of centillions of available URLs (seriously. That's a 355 digits number).

Difference Between Base 36 And Base 62 Encoding

• Base 36 encoding uses 0123456789abcdefghijklmnopqrstuvwxyz for short URLs
• Base 62 encoding uses 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz
• Stick to one setting, don't change after you've created links as it will change all your short URLs!
• Base 36 is the default and should be picked if you're not sure.

Getting a short domain name for your YOURLS install

• Unless you plan on making it public and as popular as bit.ly, any shared hosting will be fine. Ozh runs all his YOURLS instance on Dreamhost and it works just great.
• Domainr is a fun search tool that might inspire and help you
• Aim for exotic top level domains (.in, .im, .li ...), they're often cheap and a lot are still available. Gandi is a pretty comprehensive registrar, for instance.

YOURLS needs its own .htaccess

• You cannot install YOURLS and, say, WordPress, in the same directory. Both need to handle URLs differently and need their own .htaccess file.
• If you want to install YOURLS on the same domain than your blog, give it its own (short) subdirectory, such as yourblog.com/s/ (for "short") or yourblog.com/x/ (for "exit")

If YOURLS generates 404 for your short URLs

• Make sure mod_rewrite is enabled with your Apache server
• Make sure your .htaccess file looks like this one
• Eventually, check your server Apache configuration allows use of .htaccess (AllowOverride All directive, ask your server admin)

Random versus sequential short URLs

• Out of the box, YOURLS generates sequential short URLS (ie ab31, then ab32 and so on)
• If you prefer random short URLs (ie j3kz1 then 13hz7 like Bitly does), just activate the plugin that comes with YOURLS.

There is no index page at the root of the install

• Indeed. It's intended. It's up to the user to make what they need. Some will redirect the root to a different place, some make a public interface for anyone to shorten links, some make a portfolio. You make it.
• If you want to make a public interface and run your own little bitly.com, there's a sample file provided as an example: sample-public-front-page.txt. This implies important issues to deal with: spam, performance and security. Read Public Shortening for important information.

Uppercase letters in short URLs are eaten up, eg "OmgOzh" becomes "mgzh" !

• Indeed. It's intented if you selected Base 36 (see above). Letters that don't belong to the character set, eg @#! or ABC, are removed.
• If you want to force lowercase, you'll need a plugin.

Feedback, feature requests and bug reporting

1. Please don't get in touch directly by mail or Twitter. Please.
2. Check the Road Map for future features.
3. Read all the wiki documents.
4. Search in all the issues, open and closed.
5. Eventually raise a new issue. To do so, please read the contribute guidelines. Thanks!

Community

YOURLS is open source, so the community of users plays a great role in its development, by contributing, helping others or giving feedback that helps improve the software.

Resources

• The official YOURLS blog, for news, hints and showcase.
• The wiki: advanced documentation, plugins, tips and more
• Follow @YOURLS for hardcore development, and @Ozh for tips and news (and random geekiness too)

Showcase

Here are a few examples of sites running YOURLS with a unique design or concept

• http://oe.cd/
  OECD's internal URL shortener with a neat interface and private features
• http://yourwish.es/
  Easily share an Amazon wishlist
• http://vbly.us
  Public YOURLS setup and early adopter, run by famous sex writer Violet Blue as "the internet's first and only sex-positive url shortener", once taken down by Libya (story)

YOURLS and other platforms or frameworks

• WordPress
  There are numerous WordPress plugin with YOURLS support. YOURLS Link Creator is recommended.
• Drupal
  Allows for the automatic creation of short urls using a YOURLS installation
• Perl
  WWW-Shorten-Yourls is a Perl module to shorten URLs using YOURLS
• Ruby
  A Ruby wrapper for the YOURLS API
• Python
  A Python client for YOURLS
• VB .Net
  A VB .Net 4.0 wrapper for the YOURLS API
• Javascript
  JavaScript bindings for the YOURLS API to leverage JSONP support
• CakePHP
  Plugin which integrates CakePHP with Yourls
• status.net
  A plugin for status.net to use YOURLS
• Sharetronix
  A YOURLS addon for Sharetronix

YOURLS works with your favorite sofware or device

• Tweetie 2
  How to set up Tweetie2 so it uses your own service
• Tweetbot
  Make Tweetbot run with YOURLS
• Twitterfeed
  Use Twitterfeed with YOURLS
• Mac Client
  Simple app to have a global keyboard shortcut send a link to YOURLS
• Android: aYourls, URLy and URL Shortener
  Android apps that plays nice with YOURLS
• iOS: ShortTail for YOURLS, Clicklytics and myYOURLS
  Apps to use YOURLS on iPhones and iPads
• Chrourls
  Google Chrome quick link shortening addon for YOURLS
• Firefox Addon
  Firefox Addon for YOURLS
• Textexpander and YOURLS
  Making YOURLS and Textexpander on the Mac play together

More stuff to do with YOURLS

• Infinity Squared
  ∞² is a public page theme for YOURLS to help you design your own public interface
• Sleeky
  Sleeky is another public page theme for YOURLS
• Scott Helme's page
  Example index page listing all the URLs held in a YOURLS database
• http://screenr.com/nTs
  A screencast explaining how to setup YOURLS
• YOURLS: Short URL Widget
  Creates a fully configurable widget that outputs the short URL to the current post or page
• YOURLS Widget for WordPress
  This widget adds a convenient short URL service into your sidebar. Check the above link for a live example
• Twitter Tools & YOURLS
  Companion plugin for Alex King's Twitter Tool for WordPress, that enables YOURLS support
• Export URLS as text list
  A simple script to list all URLs, one per line, in plain text (for using as an indexer config file, for example)
• YOURLS featured on Lifehacker

"Celebrity endorsements", sort of.

• http://smashed.by/ by Smashing Magazine
• http://oe.cd/ by the OECD
• http://cuny.is/ by the City University of New York
• http://virg.in/ for the Virgin Group companies
• http://dhurl.org/ by Dreamhost
• https://rho.st/ by RoseHosting.com