Code source du service qrcode.chapril.org. https://qrcode.chapril.org/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

100 lines
4.1 KiB

  1. # ![](themes/dark/icons/32.png) LibreQR
  2. [Read this in english](README.md)
  3. Une interface Web en PHP pour générer des codes QR.
  4. ## Démo
  5. Une instance de LibreQR est disponible sur <https://qr.antopie.org>.
  6. ## Fonctionnement
  7. LibreQR inclus un plugin [OpenSearch](https://developer.mozilla.org/docs/Web/OpenSearch), ce qui permet de l'ajouter comme moteur de recherche dans Firefox et de sauvegarder vos paramètres.
  8. Vous pouvez ainsi générer un code QR directement depuis la barre de recherche avec les réglages de LibreQR utilisés lors de l'ajout comme moteur de recherche.
  9. Un [WebManifest](https://developer.mozilla.org/docs/Web/Manifest) est également inclus, ce qui permet de mieux l'intégrer au système via Fennec (Firefox Android) ou Chromium.
  10. Les codes QR générés sont placés dans le dossier temp/, nommés avec le nombre de caractères aléatoires indiqué dans config.inc.php (32 par défaut), puis supprimés après le temps indiqué dans config.inc.php (7 jours par défaut).
  11. Voir `config.inc.php` pour plus de paramètres.
  12. ## Installation
  13. ### Générique
  14. Placez simplement ce code source dans un serveur Web avec PHP.
  15. `wget https://code.antopie.org/miraty/libreqr/archive/1.2.0.zip`
  16. L'extension GD est requise.
  17. `apt install php7.3-gd`
  18. LibreQR a besoin des permissions d'écriture dans le dossier `temp/`.
  19. ```
  20. chown -R www-data:www-data /var/www/libreqr/temp
  21. chmod -R 600 /var/www/libreqr/temp
  22. ```
  23. ### YunoHost
  24. Il y a [un paquet](https://code.antopie.org/miraty/qr_ynh/) pour [YunoHost](https://yunohost.org/).
  25. Pour des raisons historiques, LibreQR est techniquement nommée `qr` dans YunoHost.
  26. Vous pouvez l'installer depuis l'interface Web d'administration ou avec cette commande :
  27. ```
  28. sudo yunohost app install qr
  29. ```
  30. ## Thèmes
  31. ### Changer de thème
  32. Dans config.inc.php, donnez à $theme le nom du thème voulu.
  33. Par défaut, trois thèmes sont proposés :
  34. * dark, le thème par défaut, sombre. Il est utilisé ici : <https://qr.antopie.org>
  35. * light, thème clair
  36. * parinux, un thème bleu, créé pour [Bastet](https://bastet.parinux.org), le CHATON de [Parinux](https://parinux.org). Il est utilisé ici : <https://codeqr.parinux.org>
  37. ### Créer un thème
  38. * Copiez themes/dark vers themes/[nom de votre thème]
  39. * Complétez theme.php en fonction des couleurs CSS voulues dans l'interface
  40. * Modifiez l'image source.png en fonction de votre thème
  41. * Pour générer automatiquement les icônes aux tailles correctes, utilisez `php themes/resize.php [nom du thème]`
  42. Cette dernière étape nécessite d'avoir installé [ImageMagick](https://imagemagick.org) et [pngquant](https://pngquant.org).
  43. ```apt install imagemagick pngquant```
  44. ## Contribuer
  45. Si vous souhaitez rapporter un bug, vous pouvez ouvrir un ticket sur <https://code.antopie.org/miraty/libreqr/issues> après vous être créé un compte (méthode préférée) ou me contacter d'une autre manière.
  46. ## Contact
  47. Si vous voulez me contacter, par exemple pour signaler un bug ou me poser une question sur l'installation ou l'utilisation de LibreQR, vous trouverez des moyens de me contacter sur <https://miraty.antopie.org>.
  48. ## Bibliothèques tierces
  49. Ce code source inclus :
  50. * [phpqrcode](https://github.com/t0k4rt/phpqrcode) pour générer les codes QR
  51. * [La police Ubuntu pour le Web](https://github.com/earaujoassis/ubuntu-fontface)
  52. * [lesserphp](https://github.com/MarcusSchwarz/lesserphp) pour compiler le [Less](http://lesscss.org)
  53. ## Licence
  54. [AGPLv3+](https://code.antopie.org/miraty/libreqr/src/branch/master/LICENSE)
  55. LibreQR est un logiciel libre ; vous pouvez le diffuser et le modifier suivant les termes de la GNU Affero General Public License telle que publiée par la Free Software Foundation ; soit la version 3 de cette licence, soit (à votre convenance) une version ultérieure.
  56. LibreQR est diffusé dans l’espoir qu’il sera utile, mais SANS AUCUNE GARANTIE ; sans même une garantie implicite de COMMERCIALISATION ou d’ADÉQUATION À UN USAGE PARTICULIER. Voyez la GNU Affero General Public License pour plus de détails.
  57. Vous devriez avoir reçu une copie de la GNU Affero General Public License avec ce code. Sinon, consultez <https://www.gnu.org/licenses/>