From 73f500b4d3ce64f9147d4a68fedb30d10778b0e3 Mon Sep 17 00:00:00 2001 From: Zack Scholl Date: Mon, 8 Feb 2016 13:00:23 -0500 Subject: [PATCH] Finalized makefile and install instructions --- Makefile | 2 +- README.md | 34 +++++++++++++++++++++++++++++++--- 2 files changed, 32 insertions(+), 4 deletions(-) diff --git a/Makefile b/Makefile index f215064..e0cb5a5 100644 --- a/Makefile +++ b/Makefile @@ -23,7 +23,7 @@ install: chmod +x /etc/init.d/cowyo.init mv jinstall/cowyo.nginx /etc/nginx/sites-available/cowyo.nginx rm /etc/nginx/sites-enabled/cowyo.nginx - ln -s /etc/nginx-sites-available/cowyo.nginx /etc/nginx/sites-enabled/cowyo.nginx + ln -fs /etc/nginx/sites-available/cowyo.nginx /etc/nginx/sites-enabled/cowyo.nginx /etc/init.d/nginx reload /etc/init.d/nginx restart /etc/init.d/cowyo.init restart diff --git a/README.md b/README.md index d76b2e2..2354463 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ You can also write your notes in [Markdown](https://daringfireball.net/projects/ If you are writing a list and you want to tick off things really easily, just add `/list`. For example, after editing [`/grocery`](http://cowyo.com/grocery), goto [`/grocery/list`](http://cowyo.com/grocery/list). In this page, whatever you click on will be striked through and moved to the end. This is helpful if you write a grocery list and then want to easily delete things from it. -Math is supported using [Katex](https://github.com/Khan/KaTeX). +Math is supported using [Katex](https://github.com/Khan/KaTeX). Be cautious about writing sensitive information in the notes as anyone with the URL has access to it. For more information, or if you'd like to edit the code, [use the github](https://github.com/schollz/cowyo). @@ -16,11 +16,39 @@ Be cautious about writing sensitive information in the notes as anyone with the # Install -`go install github.com/schollz/cowyo` +To get started on your local network just do: + +``` +git clone https://github.com/schollz/cowyo.git +cd cowyo +make +./cowyo -p :8001 LOCALIPADDRESS +``` + +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/`. +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: + +``` +git clone https://github.com/schollz/cowyo.git +cd cowyo +nano Makefile <--- EDIT Makefile to include YOUR EXTERNAL ADDRESS +make && sudo make install +``` + +Now the program starts and stops with + +``` +sudo /etc/init.d/cowyo start|stop|restart +``` + +Edit your crontab (`sudo crontab -e`) to start on boot: + +``` +@reboot /etc/init.d/cowyo start +``` # Usage