From 5f1edd9e535e603df374aee3d9e17dcf4490b601 Mon Sep 17 00:00:00 2001 From: Zack Date: Sat, 13 Feb 2016 23:19:40 -0500 Subject: [PATCH] Update README.md Former-commit-id: f8d2a8d36fddf1ef723bcef3737023e3de6d9c3d [formerly 89f9482f7fddd1071c631f988635e70a06219278] [formerly eef52e49afd3b2df7719451629d58f146ebace0c [formerly 15144e56fc0c28742d3bd39e3a6724e38e2e25c4 [formerly 48650192d83a62e3e29f795d2a7661d365371e08]]] Former-commit-id: e7b77853ba4908ec076dadc5b26ecbd9412f9219 [formerly 8698429f41eb5135920fd8281e883f499669262a] Former-commit-id: b8bcd4bdb7f5f7460a7ba84e6b2040f594f785df Former-commit-id: 060524d7af7d1ab2ada55d9611cc0844b9c7265b --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2f79f4f..365178f 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,11 @@ Quickly transition between Edit/View/List by using `Ctl+Shift+E` to Edit, `Ctl+S The Admin can view/delete all the documents by setting the `-a YourAdminKey` when starting the program. Then the admin has access to the `/ls/YourAdminKey` to view and delete any of the pages. # Install -To get started on your local network just do: + + +First [install Go](https://golang.org/doc/install). + +Then, if you want to host on your local network just do: ``` git clone https://github.com/schollz/awwkoala.git @@ -44,7 +48,7 @@ make and then goto the address `http://LOCALIPADDRESS:8001/` ## Production server -I recommend using `NGINX` as middleware, as it will do caching of the static files for you. There is an example `NGINX` block in `install/`. To automatically install, on Raspberry Pi / Ubuntu / Debian system use: +I recommend using `NGINX` as middleware, as it will do caching of the static files for you. There is an example `NGINX` block in `install/`. If you want to use SSL instead, follow the instructions in `letsencrypt/README.md`. To automatically install, on Raspberry Pi / Ubuntu / Debian system use: ``` git clone https://github.com/schollz/awwkoala.git