Added README

1 files changed, 40 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..66c1cdf
--- /dev/null
+++ b/README
@@ -0,0 +1,40 @@
+A webapp that allows me to send push notifications to my roommate.
+
+Overview:
++Client Web Browser-----------------+
+|     index.html and JQuery         |
+|         |              |          |
++---------|--------------|----------+
+          |served over   |          
+          |https         |GET/POST API
+          |              |          
++Server---|--------------|----------+
+|       nginx         backend       |
+|                                   |
++-----------------------------------+
+
+Install steps
+obtain certificates, I recommend certbot
+$ certbot certonly -d $DOMAIN
+
+select option 2 for temporary webserver
+
+copy ja.hairydiode.xyz.conf to /etc/nginx/sites-available and rename to
+$DOMAIN.conf
+
+link /etc/nginx/sites-enabled/$DOMAIN.conf to the above mentioned file
+
+edit all mentions of ja.hairydiode.xyz to $DOMAIN
+
+to make this the only thing being served, add default_server to the end of all
+listen lines
+ex:
+-	listen 80;
+-	listen [::]:80;
++	listen 80 default_server;
++	listen [::]:80 default_server;
+
+copy this repository to /var/www/justinalert
+
+run nginx, on debian this should be:
+systemctl start nginx