1
0
mirror of https://github.com/schollz/cowyo.git synced 2023-08-10 21:13:00 +03:00
Go to file
Zack 08586ea02a Update cowyo.init
Former-commit-id: f9cc519ed696988d290bcf2e44e27f343e45ffea [formerly 1dd981817e9ae27e964bb787ed0fa4f4f81b1203] [formerly e86ce98489854e79a0d131e7605f7f652c107a2b [formerly 274a058f72da8c8b8b425ba9cd9495f6ebd9f277 [formerly 17b139765b]]]
Former-commit-id: 4dc3a1fb64ddcf8c03936b65480b167555696330 [formerly fc003c1cbefcfabe874234a4b770bc87e7023b37]
Former-commit-id: f4c7141be4a88110f90fcfc55fdf440e77988675
Former-commit-id: 1581b15e91
2016-02-08 11:28:04 -05:00
install Update cowyo.init 2016-02-08 11:28:04 -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 not Using CDN 2016-02-08 10:27:44 -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
README.md Update README.md 2016-02-08 11:10:46 -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

go install github.com/schollz/cowyo

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

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