1
0
mirror of https://github.com/schollz/cowyo.git synced 2023-08-10 21:13:00 +03:00
Go to file
Zack 7a502c0fde Update README.md
Former-commit-id: 09ac10a01630de3205bf4fad8b6d8752fe329fe7 [formerly 37a289abeeb2aa186f855acbfbc55cbde4e2bca8] [formerly c70a678078f9e0669efd4d42c3bc46ba21a12758 [formerly bbeee5417f]]
Former-commit-id: a832123575da420c601ca6fca37bc148b1bd028b [formerly 62c0c3f00d4b1d1509ce776c413022c368d9fa1d]
Former-commit-id: 5d89477ba1235e4bab85d40e088f07c5b440472d
2016-02-08 11:10:46 -05:00
install Update nginx to allow serving static 2016-02-08 10:31:33 -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")```