From 9b147ecc379c7de979ba543c08c3c8758ad18625 Mon Sep 17 00:00:00 2001 From: Miraty Date: Fri, 4 Mar 2022 01:09:24 +0100 Subject: [PATCH] Update README about themes and add security hardening section --- README.md | 29 ++++++++++------------------- README_fr.md | 31 +++++++++++-------------------- 2 files changed, 21 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index cf423bd..4a89128 100755 --- a/README.md +++ b/README.md @@ -27,6 +27,14 @@ chown -R www-data:www-data /var/www/libreqr/css chmod -R 600 /var/www/libreqr/css ``` +#### Security hardening + +Your HTTP server can reply the following headers: +``` +Content-Security-Policy: default-src 'none'; img-src 'self' data:; style-src 'self'; frame-ancestors 'none'; form-action 'self'; +Referrer-Policy: no-referrer +``` + ### YunoHost There is [a package](https://code.antopie.org/miraty/qr_ynh/) for [YunoHost](https://yunohost.org/). @@ -41,26 +49,9 @@ sudo yunohost app install qr ## Themes -### Change theme +Themes are located in `themes/*`, the default theme is in `themes/libreqr/`. -In config.inc.php, set $theme to the wanted theme. - -By default, 3 themes are offered: - -* dark, the default dark theme. Used here: -* light, the light theme. -* parinux, a blue theme, made for [Bastet](https://bastet.parinux.org), the [Parinux](https://parinux.org)'s CHATON. Used here: - -### Make a theme - -* Copy themes/dark to themes/[new theme's name] -* Fill theme.php according to CSS colors you want -* Change the source.png image according to your theme -* To automatically generate favicons with the rights sizes, use `php themes/resize.php [theme's name]` - -This last step will need [ImageMagick](https://imagemagick.org) and [pngquant](https://pngquant.org) to be installed. - -```apt install imagemagick pngquant``` +You can customize your LibreQR instance look by changing the colors in `theme.php`, the logo in `logo.less` or the icons in `icons/.png` (then list the sizes in `theme.php`). ## Contribute diff --git a/README_fr.md b/README_fr.md index 5dd37c1..292f29d 100644 --- a/README_fr.md +++ b/README_fr.md @@ -27,6 +27,14 @@ chown -R www-data:www-data /var/www/libreqr/css chmod -R 600 /var/www/libreqr/css ``` +#### Durcir la sécurité + +Votre serveur HTTP peut répondre avec les entêtes suivantes : +``` +Content-Security-Policy: default-src 'none'; img-src 'self' data:; style-src 'self'; frame-ancestors 'none'; form-action 'self'; +Referrer-Policy: no-referrer +``` + ### YunoHost Il y a [un paquet](https://code.antopie.org/miraty/qr_ynh/) pour [YunoHost](https://yunohost.org/). @@ -39,28 +47,11 @@ Vous pouvez l'installer depuis l'interface Web d'administration ou avec cette co sudo yunohost app install qr ``` -## Thèmes +## Themes -### Changer de thème +Les thèmes sont situés dans `themes/`, le thème par défaut est dans `themes/libreqr`. -Dans config.inc.php, donnez à $theme le nom du thème voulu. - -Par défaut, trois thèmes sont proposés : - -* dark, le thème par défaut, sombre. Il est utilisé ici : -* light, thème clair -* parinux, un thème bleu, créé pour [Bastet](https://bastet.parinux.org), le CHATON de [Parinux](https://parinux.org). Il est utilisé ici : - -### Créer un thème - -* Copiez themes/dark vers themes/[nom de votre thème] -* Complétez theme.php en fonction des couleurs CSS voulues dans l'interface -* Modifiez l'image source.png en fonction de votre thème -* Pour générer automatiquement les icônes aux tailles correctes, utilisez `php themes/resize.php [nom du thème]` - -Cette dernière étape nécessite d'avoir installé [ImageMagick](https://imagemagick.org) et [pngquant](https://pngquant.org). - -```apt install imagemagick pngquant``` +Vous pouvez personnaliser l'apparence de votre instance LibreQR en changeant les couleurs dans `theme.php`, le logo dans `logo.less` ou les icônes dans `icons/.png` (ensuite indiquer leur taille dans `theme.php`). ## Contribuer