Lacre/lacre-webgate
5
2
Fork 0
Code Issues 10 Pull requests Projects Releases 2 Packages Wiki Activity

Update README: link to backend repository, reformat instructions

Browse source
This commit is contained in:
Piotr F. Mieszkowski 2023-12-02 18:55:41 +01:00
parent ce20926ce6
commit ca8bda5a83
1 changed files with 8 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -2,6 +2,8 @@ Lacre Webgate
-------------- --------------
This is Lacre's simple php based frontend. It has been forked from [gpg-mailgate](https://github.com/fkrone/gpg-mailgate) project and it is a continuation of the original work. Special thanks to all those who have contributed to amazing work of gpg-mailgate-web and those who are willing to contribute to Lacre to improve security of email storage. This is Lacre's simple php based frontend. It has been forked from [gpg-mailgate](https://github.com/fkrone/gpg-mailgate) project and it is a continuation of the original work. Special thanks to all those who have contributed to amazing work of gpg-mailgate-web and those who are willing to contribute to Lacre to improve security of email storage.
For the backend, see [lacre](https://git.disroot.org/Disroot/gpg-lacre).
Lacre-Webgate is a simple web interface designed to allow any web user to upload their PGP public key and then have all mail sent via your mail server be encrypted. (Note: this is not meant for email authentication, only encryption.) Lacre-Webgate is a simple web interface designed to allow any web user to upload their PGP public key and then have all mail sent via your mail server be encrypted. (Note: this is not meant for email authentication, only encryption.)
After submitting their key to a web form, the user will be required to confirm their email address. A cron script will register the public key with gpg-lacre (keyhome_only must be set to no currently, which is the default) after email confirmation. From then on, email to the specified address will be encrypted with the public key. After submitting their key to a web form, the user will be required to confirm their email address. A cron script will register the public key with gpg-lacre (keyhome_only must be set to no currently, which is the default) after email confirmation. From then on, email to the specified address will be encrypted with the public key.
@ -15,16 +17,16 @@ Note that all processing relating to the mail server is done via the cron script
1. Installation instructions: 1. Installation instructions:
Below instructions assume working gpg-Lacre setup (backend) as well as working web-server (eg. nginx+php8) and sql database (eg. mariadb). Below instructions assume working gpg-Lacre setup (backend) as well as working web-server (eg. nginx+php8) and sql database (eg. mariadb).
1) Create a MySQL database for Lacre-Web. 1) Create a MySQL database for Lacre-Web.
a) Schema file is located in schema.sql a) Schema file is located in schema.sql
b) Database name and account goes in /etc/gpg-lacre.conf (and set enabled = yes) b) Database name and account goes in /etc/gpg-lacre.conf (and set enabled = yes)
3) Copy the contents of public_html to your web directory. 2) Copy the contents of public_html to your web directory.
4) Move config.sample.php to config.php and edit the configuration file. 3) Move config.sample.php to config.php and edit the configuration file.
5) Copy cron.py to /usr/local/bin/Lacre-web-cron.py and set up a cron job 4) Copy cron.py to /usr/local/bin/Lacre-web-cron.py and set up a cron job
``` ```
*/3 * * * * lacre /usr/bin/python /usr/local/bin/Lacre-web-cron.py > /dev/null */3 * * * * lacre /usr/bin/python /usr/local/bin/Lacre-web-cron.py > /dev/null
``` ```
6) Ensure that cron is working and test your new Lacre-web installation! 5) Ensure that cron is working and test your new Lacre-web installation!
2. Customization: 2. Customization:
Lacre-Webgate allows for customization of css as well as templates. You can add your custom theme to `/themes/`. You can switch theme by adjusting `$config['site_theme']` in config.php` where the name is the theme's directory name. Lacre-Webgate allows for customization of css as well as templates. You can add your custom theme to `/themes/`. You can switch theme by adjusting `$config['site_theme']` in config.php` where the name is the theme's directory name.