forked from miraty/libreqr
Update README
This commit is contained in:
parent
fdfa947fc0
commit
5e455c1499
1 changed files with 13 additions and 7 deletions
20
README.md
20
README.md
|
@ -10,20 +10,22 @@ A LibreQR instance is available at <https://qr.antopie.org>.
|
|||
|
||||
### Generic
|
||||
|
||||
Just place this source code in a Web server with PHP.
|
||||
|
||||
PHP extensions GD and iconv are required.
|
||||
|
||||
LibreQR need writing rights on the `css/` directory.
|
||||
Just place this source code in a Web server with PHP7.4+, 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](https://code.antopie.org/miraty/qr_ynh/) for [YunoHost](https://yunohost.org/).
|
||||
|
@ -44,11 +46,15 @@ You can customize your LibreQR instance look by changing the colors in `theme.ph
|
|||
|
||||
## Contribute
|
||||
|
||||
If you want to report a bug, you can open an issue at <https://code.antopie.org/miraty/libreqr/issues> after creating an account (prefered method) or contact me in another way.
|
||||
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
|
||||
|
||||
If you want to contact me, for instance to report a bug or ask me a question about installing or using LibreQR, you can get my contact details on <https://miraty.antopie.org>.
|
||||
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
|
||||
|
||||
|
|
Loading…
Reference in a new issue