1
0
mirror of https://github.com/schollz/cowyo.git synced 2023-08-10 21:13:00 +03:00
Go to file
Zack Scholl 67744f2d26 New image
Former-commit-id: a4efc6f5e3ebb5727779715a77235fd00e04f7f1 [formerly dd482e5176c70a830553fb16807c19ec7eed712a] [formerly 4de4df5a38e72c3e78bf4bb20d7b2f40b1bc7c68 [formerly a17e03148f36afbb13ebb6cb47b701d28b4a2d4e [formerly d6b2c9a04c]]]
Former-commit-id: f73f1051006825afc504d819c7ce3a45d7bac079 [formerly cca890e7fc0f80fd64b1619e21ece58a8e40d02e]
Former-commit-id: 62f2c4c544f5a15110254cca64bce52cc8c63c59
Former-commit-id: 296baa0e29
2016-02-08 17:47:12 -05:00
install updated nginx 2016-02-08 12:46:25 -05:00
ssl enable TLS as option 2016-02-07 10:20:41 -08:00
static New image 2016-02-08 17:47:12 -05:00
templates Need to load jquery before bootsrap 2016-02-08 13:37:43 -05:00
.gitignore Initial commit 2016-02-06 08:28:40 -05:00
db.go Loads current text statically. Faster loading 2016-02-08 08:37:22 -05:00
LICENSE Initial commit 2016-02-06 08:28:40 -05:00
main.go Added nginx to readme, about 2016-02-08 17:47:07 -05:00
Makefile Finalized makefile and install instructions 2016-02-08 13:00:23 -05:00
README.md Added nginx to readme, about 2016-02-08 17:47:07 -05:00
routes.go Added admin priveleges to list all the notes 2016-02-08 17:37:33 -05:00
utils.go Added nginx to readme, about 2016-02-08 17:47:07 -05:00
websockets.go Removed case senstivity from savin 2016-02-08 01:37:46 +00:00

Cowyo...

...is the Collection of Online Words You Open.

This tool is supposed to make sharing online notes and lists fast and easy. To jot a note, simply load the page at / and write. The url will redirect to an easy-to-remember name that you can use to reload the page at anytime, anywhere. (You can use any url you want too: /AnythingYouWant). No need to press save, it will automatically save when you stop writing.

You can also write your notes in Markdown and then render your page by adding /view. For example, the page /about is rendered at /about/view.

If you are writing a list and you want to tick off things really easily, just add /list. For example, after editing /grocery, goto /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.

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.

Powered by Raspberry Pi, Go, and NGINX

Raspberry Pi Go Mascot Nginx

Install

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/. 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

$ cowyo --help
cowyo: a websocket notepad
run this to start the server and then visit localhost at the port you specify
(see parameters).
Example: 'cowyo localhost'
Example: 'cowyo -p :8080 localhost'
Example: 'cowyo -db /var/lib/cowyo/db.bolt localhost'
Example: 'cowyo -p :8080 -crt ssl/server.crt -key ssl/server.key localhost'
Options:
  -a string
        key to access admin priveleges (default no admin priveleges)
  -crt string
        location of ssl crt
  -db string
        location of database file (default "/home/mu/cowyo/data.db")
  -httptest.serve string
        if non-empty, httptest.NewServer serves on this address and blocks
  -key string
        location of ssl key
  -p string
        port to bind (default ":12312")```