YOURLS, Your Own URL Shortener ( votre propre raccourcisseur de lien)

ll y a quelques semaines, j’ai trouvé un nom de domaine sympathique (jerom.me) pour faire ma page type linktree, une page permettant de se rendre sur ce blog et sur mes principaux réseaux sociaux.

Fier de ce beau nom de domaine, j’ai décidé de l’exploiter un peu plus et d’y installer mon propre raccourcisseur de lien internet (url). Après une recherche de 30 secondes sur internet j’ai trouvé le script déjà tout fait, visiblement très utilisé et mise à jour régulièrement : YOURLS ( Your Own URL Shortener). Dans les lignes ci-dessous, je vous explique comment installer ce script en quelques minutes ce script et comment il fonctionne.

🛠️ L’installation

Prérequis

  • un hébergement web
  • une base de données sql dédiée à l’application ou partagée
  • un éditeur de texte
  • 15 minutes de votre temps

Préparation de l’installation

Avant de lancer l’application, il faudra, dans un premier temps, créer une base de données SQL et noter les informations de connexions. Et bien entendu il faut décider à quel emplacement vous allez stocker l’application sur votre hébergement. Dans mon cas j’ai opté pour un sous-domaine qui sera l.jerom.me.

Téléchargement du script

Pour télécharger la dernière version du script, il faut aller sur la page github du projet : https://github.com/YOURLS/YOURLS/releases

Modification du fichier de configuration avec vos propres informations

Avant de personnaliser le fichier de configuration qui se trouve dans le répertoire « user », il faudra en faire une copie et le nommer « config.php ».

Ensuite, il faut ouvrir le nouveau fichier et documenter les informations de votre base de données, du domaine sur lequel l’application fonctionnera et enfin de choisir un nom et mot de passe pour la partie « admin ». Pas d’inquiétude, vous pouvez documenter le mot de passe en clair, il sera chiffré au lancement de l’application.

<?php
/* This is a sample config file.
 * Edit this file with your own settings and save it as "config.php"
 *
 * IMPORTANT: edit and save this file as plain ASCII text, using a text editor, for instance TextEdit on Mac OS or
 * Notepad on Windows. Make sure there is no character before the opening <?php at the beginning of this file.
 */

/*
 ** MySQL settings - You can get this info from your web host
 */

/** MySQL database username */
define( 'YOURLS_DB_USER', 'your db user name' );

/** MySQL database password */
define( 'YOURLS_DB_PASS', 'your db password' );

/** The name of the database for YOURLS
 ** Use lower case letters [a-z], digits [0-9] and underscores [_] only */
define( 'YOURLS_DB_NAME', 'yourls' );

/** MySQL hostname.
 ** If using a non standard port, specify it like 'hostname:port', e.g. 'localhost:9999' or '127.0.0.1:666' */
define( 'YOURLS_DB_HOST', 'localhost' );

/** MySQL tables prefix
 ** YOURLS will create tables using this prefix (eg `yourls_url`, `yourls_options`, ...)
 ** Use lower case letters [a-z], digits [0-9] and underscores [_] only */
define( 'YOURLS_DB_PREFIX', 'yourls_' );

/*
 ** Site options
 */

/** YOURLS installation URL
 ** All lowercase, no trailing slash at the end.
 ** If you define it to "http://sho.rt", don't use "http://www.sho.rt" in your browser (and vice-versa)
 ** To use an IDN domain (eg http://héhé.com), write its ascii form here (eg http://xn--hh-bjab.com) */
define( 'YOURLS_SITE', 'http://your-own-domain-here.com' );

/** YOURLS language
 ** Change this setting to use a translation file for your language, instead of the default English.
 ** That translation file (a .mo file) must be installed in the user/language directory.
 ** See http://yourls.org/translations for more information */
define( 'YOURLS_LANG', '' );

/** Allow multiple short URLs for a same long URL
 ** Set to true to have only one pair of shortURL/longURL (default YOURLS behavior)
 ** Set to false to allow multiple short URLs pointing to the same long URL (bit.ly behavior) */
define( 'YOURLS_UNIQUE_URLS', true );

/** Private means the Admin area will be protected with login/pass as defined below.
 ** Set to false for public usage (eg on a restricted intranet or for test setups)
 ** Read http://yourls.org/privatepublic for more details if you're unsure */
define( 'YOURLS_PRIVATE', true );

/** A random secret hash used to encrypt cookies. You don't have to remember it, make it long and complicated
 ** Hint: copy from http://yourls.org/cookie */
define( 'YOURLS_COOKIEKEY', 'modify this text with something random' );

/** Username(s) and password(s) allowed to access the site. Passwords either in plain text or as encrypted hashes
 ** YOURLS will auto encrypt plain text passwords in this file
 ** Read http://yourls.org/userpassword for more information */
$yourls_user_passwords = [
	'username' => 'password',
	// 'username2' => 'password2',
	// You can have one or more 'login'=>'password' lines
];

/** URL shortening method: either 36 or 62
 ** 36: generates all lowercase keywords (ie: 13jkm)
 ** 62: generates mixed case keywords (ie: 13jKm or 13JKm) 
 ** For more information, see https://yourls.org/urlconvert */
define( 'YOURLS_URL_CONVERT', 36 );

/** Debug mode to output some internal information
 ** Default is false for live site. Enable when coding or before submitting a new issue */
define( 'YOURLS_DEBUG', false );

/**
* Reserved keywords (so that generated URLs won't match them)
* Define here negative, unwanted or potentially misleading keywords.
*/
$yourls_reserved_URL = [
	'porn', 'faggot', 'sex', 'nigger', 'fuck', 'cunt', 'dick',
];

/*
 ** Personal settings would go after here.
 */

Pour l’option en surlignée en orange il faudra se rendre sur la page « http://yourls.org/cookie » et de copier la ligne qui aura généré aléatoirement par le site et de remplacer la ligne entière.

Votre fichier de configuration est prêt.

Copie des fichiers sur votre hébergement

Il ne vous reste plus qu’à charger l’intégralité des fichiers/répertoires du script dans le répertoire de votre hébergement et le tour est joué.

Premier lancement, initialisation de la base de données.

Au premier lancement de l’application, il faut se rendre dans la partie admin : monsite.com/admin/ et lancer l’installation, ce qui se chargera de créer les tables dans la base de données, ça ne prendra que qq seconde.

Votre raccoussieur d’URL est prêt.

🔗 Utilisation

Ajouter un raccourci

L’utilisation de YOURLS est super simple. Pour ajouter un raccourci, il suffit de se rendre sur la page « votresite.com/admin/ » et de documenter votre mot de passe.

Ensuite il faut entrer l’URL cible et le nom du raccourci choisi, et voilà, le tour est joué.

Pour aller plus loin

Avec ce raccourcisseur de liens, vous pourrez également tracker les connexions aux raccourcis, ce qui peut avoir un intérêt pour certains liens. Vous pourrez ainsi connaitre le nombre de clics vers une page ou un site qui n’a pas de statistiques, vous pourrez connaitre également la localisation de personnes qui consultent le lien et la source du trafic (depuis quel site le lien a été consulté).

💡 Enfin si vous avez besoin de plus de fonctionnalités vous trouverez certainement parmi la centaine de plugins développer pour YOURLS (voir lien ci-dessous)


Voilà vous savez maintenant quasiment tout sur YOURLS, si vous êtes intéressé pour déployer cette application sur l’un de vos sites je vous invite à suivre les 3 liens ci-dessous. Si vous avez des plugins à me conseiller, n’hésitez pas à me les recommander en commentaire.

Leave a reply

Your email address will not be published. Required fields are marked *

Cookies Notice

jeromep.net utilise des cookies pour vous garantir la meilleure expérience. En continuant votre navigation vous en acceptez leur utilisation.