1
0
mirror of https://github.com/schollz/cowyo.git synced 2023-08-10 21:13:00 +03:00
Go to file
Zack Scholl 2352568938 Need to load jquery before bootsrap
Former-commit-id: 585a5f025638af3413d6c614cba51b5e4b323583 [formerly 2eeb6b6717811bcb465782e4b9c65a455aaaedf0] [formerly de0f557e804b5cfb15b91e7d98328f8ee2f4f052 [formerly 10fca93d2a2e34149c5c8795095a9cf6f31b9373 [formerly 5048dffb23]]]
Former-commit-id: d2bd4a0bc7e9bad3aa1a10adb8e94bbbace40a81 [formerly 9b58f2ea8feb70f51ee13da9a27f371fb8af5254]
Former-commit-id: 41dcd84d3cd2583a3802f1fdfb6922568a6526a7
Former-commit-id: a38648d46e
2016-02-08 13:37:43 -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 Fixed folders for static 2016-02-08 10:10:48 -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 Fixed folders for static 2016-02-08 10:03:00 -05:00
Makefile Finalized makefile and install instructions 2016-02-08 13:00:23 -05:00
README.md Finalized makefile and install instructions 2016-02-08 13:00:23 -05:00
routes.go Fixed folders for static 2016-02-08 10:05:23 -05:00
utils.go Storing DIffs now...might not be compatible? 2016-02-07 18:31:47 -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 and Go Raspberry Pi Go Mascot

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:
  -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")```