libreqr/README.md
2023-07-08 18:48:26 +02:00

2.3 KiB
Executable file

LibreQR

A PHP Web interface for generating QR codes.

Demo

A LibreQR instance is available at https://qr.antopie.org.

Installation

Generic

Just place this source code in a Web server with PHP8.0+, extensions gd, mbstring and iconv, and writing rights on the css/ directory.

Security hardening

HTTP headers

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
PHP-FPM chroot

LibreQR can be chrooted using PHP-FPM.

YunoHost

There is a package for YunoHost.

For historical reasons, LibreQR is technically named qr in YunoHost.

You can install it from the WebAdmin or with this command:

sudo yunohost app install qr

Themes

Themes are located in themes/*, the default theme is in themes/libreqr/.

You can customize your LibreQR instance look by changing the colors in theme.php, the logo in logo.less or the icons in icons/<size>.png (then list the sizes in theme.php).

Contribute

The public forge is https://code.antopie.org/miraty/libreqr. You can open issues and pull requests there.

Translations

You can add your translations in locales/<language-code>.php.

Contact

You can get my contact details on https://miraty.antopie.org/, feel free to use them if you want more informations about using or contributing to LibreQR.

License

LibreQR is published under AGPLv3+. Librairies located in the vendor subdirectory use their own licenses.

LibreQR is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

LibreQR is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.