mirror of
https://github.com/schollz/cowyo.git
synced 2023-08-10 21:13:00 +03:00
2283af8cc1
Former-commit-id: 5695ac88899e700e190ddc0bc9466ea3ba1033b9 [formerly c4a2f0d21892746681a3d985f450073a752d026b] [formerly 2ffa803285c2d5da541c7ebf171d6fc9c7630c28 [formerly 4560a531f2e198b7a1c20692917d5e518e7a4052 [formerly76863b058e]]] Former-commit-id: 562a7043ad4106022d08b9a7d49c6c2edbbf6cf3 [formerly 7b78c90f4172d7cfad9297ff0f5b13d539b8f4fc] Former-commit-id: e3bbab6185ed17262f6763461ff212f0f6b2067c Former-commit-id:aeb3dddeda
80 lines
3.1 KiB
Markdown
80 lines
3.1 KiB
Markdown
# 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 [`/`](http://cowyo.com/) 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`](http://cowyo.com/AnythingYouWant)). No need to press save, it will automatically save when you stop writing.
|
|
|
|
You can also write your notes in [Markdown](https://daringfireball.net/projects/markdown/) and then render your page by adding `/view`. For example, the page `/about` is rendered at [`/about/view`](/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`](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). Base64 images are supported [in img tags](https://stackoverflow.com/questions/1207190/embedding-base64-images) as well.
|
|
|
|
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).
|
|
|
|
**Powered by Raspberry Pi, Go, and 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")```
|
|
```
|