README.md

PRINCIPE

PyShort à un raccourcisseur d'URL compatible avec une connexion sécurisé reposant sur une base SQL. Elle se destine principalement au programmeur souhaitant disposé d'un système pour raccourcir les URL à moindre coût.

INSTALLATION & MISE A JOUR

Si PyShort est déjà installé, commencer par supprimer l'image :

docker rm -f pyshort

puis télécharger la dernière version :

docker pull f80hub/pyshort:latest

enfin créer un répertoire (par exemple /root/data) pour héberger la base de données et un répertoire /root/certs pour stocker le certificat du serveur si vous souhaitez une connexion sécurisée (fichiers fullchain.pem et privkey.pem) puis installer l'image docker simplement par :

docker run --restart=always -v /root/datas:/app/datas -v /root/certs:/app/certs -p 443:443 --name pyshort -d f80hub/pyshort:latest domain_server 443 ssl

le paramètre SSL doit être ajouté si vous souhaitez une connexion sécurisée.

FONCTIONNEMENT

La réduction se fait via l'usage de l'API short. Celle-ci est utilisable en

GET /short?url=votre_url&format=text|qrcode

ou en POST en plaçant votre url dans le corps.

En précisant le format text ou qrcode, l'API répond par une url ou directement par une image au format PNG correspondant au QRCode de l'url