diff --git a/README.md b/README.md index b154ec9..d618c11 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Host a submission form on an untrusted or shared host by using public-key encryption! This repository hosts the source code for the Lockbox app, which works together with the [Lockbox web app](https://git.openprivacy.ca/openprivacy/lockbox-web). -Lockbox is a barebones form submission app intended to be easily adaptable for different needs. It works by capturing all submitted +Lockbox is a barebones form submission app intended to be easily adaptable for different needs. It works by capturing all submitted form data and encrypting it with a (libsodium) public key before saving it. Saved data can only be read by decrypting it with your unique private key, which can be kept offline and protected however you like. ## Installation @@ -15,6 +15,7 @@ Lockbox is a barebones form submission app intended to be easily adaptable for d ## Usage * Submissions can only be decrypted using the `key.private` you generated earlier. +* Download the encrypted `submissions.dat` file either directly from your server or by using the renamed `admin.php` script. * Use the Lockbox app or `cmd/decrypt.php` to decrypt submissions. It will output a CSV file that can be opened in any spreadsheet editor (such as Microsoft Excel or LibreOffice Calc). ## Making HTML forms @@ -23,4 +24,4 @@ Lockbox is a barebones form submission app intended to be easily adaptable for d * The submission script will capture all form fields submitted to it. * Field ordering is not preserved by default. If you would like spreadsheet columns to appear in a certain order, you can give your form fields a number and an underscore, for example `01_name`, `02_address`, `03_phone` etc. The Lockbox app will remove the numeric prefix when creating the spreadsheet. * Do not name a form field `email` as it is used for detecting bots. -* Submission time, submission number, and submitter IP address are all added automatically. \ No newline at end of file +* Submission time, submission number, and submitter IP address are all added automatically.