Commit Diff


commit - 11d61b3135b61ad7b2175da11ff34c43cd968eb2
commit + d0df41915c64d556c6d187d9b8751038ac6072bb
blob - 3bae17b06f949a7819f8ea5fe53aca25c1c6a193
blob + 7279fb7aaedbaddc03604c04a2e91100814db2ff
--- README.md	
+++ README.md	
@@ -1,19 +1,118 @@
-# SecuritX
+SecuritX
+--------
 
-## Introduction
 SecuritX is a simple and secure document uploader for easy sharing of protected
-health information. Developed on OpenBSD.
+health information PDFs. SecuritX is developed on OpenBSD.
 
-THIS SOFTWARE IS NOT READY TO BE CLONED. Please wait for release. The
-functionality is not completed. When all functionality is completed, then
-releases will occur.
+Features
+--------
 
-## httpd
+* On-disk encryption for data at rest
+* Admins and editors can invite members for direct sharing outside of the company upload area
+* Automatic member and file clean up via Cron
+* 2FA verification after 24 hours of inactivity
+* Ability to block domains and members by email address
+* Simple installation
 
+Installation
+------------
+
+## Clone SecuritX
+
 ```bash
+# cd /var/www/got/public
+# got clone -a ssh://git@github.com/basepr1me/SecuritX.git
+# cd /var/www
+# got co /var/www/got/public/SecuritX.git securitx
+```
+
+## Edit global.php
+
+You will need to sign up for reCaptcha keys and edit /var/www/securitx/config/autoload/global.php.
+
+```bash
+	'email_host' => [
+		'hostname'	=> 'securitx.localhost',
+		'ip'		=> '127.0.0.1',
+	],
+	'recaptcha' => [
+		'site_key' => "enter recaptcha site key",
+		'secret_key' => "enter recaptcha secret key",
+	],
+```
+
+## Folders chmod
+
+```bash
+# chmod -R 777 /var/www/securitx/data
+# chown -R www:www /var/www/securitx/data
+
+# chmod 1777 /var/www/tmp
+# chmod 1777 /var/www/securitx/data/tmp
+```
+
+## fstab
+
+Adjust sizes to your needs.
+
+```bash
+swap /var/www/securitx/data/tmp mfs rw,nodev,nosuid,-s500M 0 0
+swap /var/www/tmp mfs rw,nodev,nosuid,-s500M 0 0
+
+# mount /var/www/securitx/data/tmp
+# mount /var/www/tmp
+```
+
+edit emailhost in config/autoload/global.php
+The src/Form/MemberForm.php document requires reCAPTCHA keys.
+
+## PHP
+
+```bash
+# pkg_add php
+```
+
+### WWW shell
+
+```bash
+# cp -p /bin/sh /var/www/bin
+```
+
+Adjust these settings in php-#-#.ini to your needs:
+
+```bash
+upload_max_filesize = 500M
+post_max_size = 500M
+max_file_uploads = 20
+```
+
+## httpd.conf
+
+```bash
 server "securitx.localhost" {
 	listen on $ext_if port 80
 
+	location "/.well-known/acme-challenge/*" {
+		root "/acme"
+		request strip 2
+	}
+	location "/*" {
+		block return 302 "https://$SERVER_NAME$REQUEST_URI"
+	}
+}
+
+server "securitx.localhost" {
+	listen on $ext_if tls port 443
+
+	# adjust for your setup
+        connection { max request body 60000000000 }
+	connection { request timeout 2400 }
+	connection { timeout 2400 }
+	hsts max-age 15552000
+
+	tls certificate "/etc/ssl/securitx.localhost.fullchain.pem"
+	tls key "/etc/ssl/private/securitx.localhost.key"
+
 	root "/securitx/public"
 
 	location "/img/*" {
@@ -34,33 +133,19 @@ server "securitx.localhost" {
 	}
 }
 
-cp -p /bin/sh /var/www/bin
 ```
 
-make pretty later:
+## Start daemons
 
-installation instructions
+```bash
+# rcctl start php##_fpm https
+```
 
-httpd.conf and php.ini set accordingly to your needs:
-upload_max_filesize = 500M
-post_max_size = 500M
-max_file_uploads = 20
+Author
+------
 
-connection { max request body 60000000000 }
-connection { request timeout 2400 }
-connection { timeout 2400 }
+[Tracey Emery](https://github.com/basepr1me/)
 
-Folders:
-chmod -R 777 /var/www/securitx/data
-chown -R www:www /var/www/securitx/data
+If you like this software, consider [donating](https://k7tle.com/?donate=1).
 
-chmod 1777 /var/www/tmp
-chmod 1777 /var/www/securitx/data/tmp
-
-fstab:
-swap /var/www/securitx/data/tmp mfs rw,nodev,nosuid,-s500M 0 0
-swap /var/www/tmp mfs rw,nodev,nosuid,-s500M 0 0
-
-upgrade instructions
-edit emailhost in config/autoload/global.php
-The src/Form/MemberForm.php document requires reCAPTCHA keys.
+See the [License](LICENSE.md) file for more information.
blob - f4971a3471b9aebbbb2a5d9b03ab3004684d5ed5
blob + 6c080a6cdb36d6dca86ab32d1d0ef655f8700a11
--- config/autoload/global.php	
+++ config/autoload/global.php	
@@ -18,16 +18,16 @@ return [
 		'hostname'	=> 'securitx.localhost',
 		'ip'		=> '127.0.0.1',
 	],
+	'recaptcha' => [
+		'site_key' => "enter recaptcha site key",
+		'secret_key' => "enter recaptcha secret key",
+	],
 
 	/* do not edit beyond this point */
 	'db' => [
 		'driver'	=> 'Pdo_Sqlite',
 		'dsn'		=> sprintf('sqlite:%s/data/securitx.db', realpath(getcwd())),
 	],
-	'recaptcha' => [
-		'site_key' => "enter recaptcha site key",
-		'secret_key' => "enter recaptcha secret key",
-	],
 	'hipaa' => [
 		'notice' => 'DISCLOSURE: This message is intended only for the use of the individual(s) to whom it is addressed and contains information that is privileged, confidential, and exempt from disclosure under applicable law. Any further dissemination or copying of this communication is strictly prohibited. If you have received this communication in error, please notify us immediately by telephone or email as listed in our signature above. This message is provided in accordance with HIPAA Omnibus Rule of 2013.',
 	],