1
0
mirror of https://github.com/schollz/cowyo.git synced 2023-08-10 21:13:00 +03:00
Go to file
Zack Scholl b7e0bb94d9 Renaming
Former-commit-id: e8d2a9531961624a39a42eb9ae3c35191bc8498d [formerly 8b09b7227e9b5e1e44be028a9026b240f735da22] [formerly ed47e3277e41f092901b1efd73ad03ffab65500d [formerly b74eb0f524]]
Former-commit-id: 73cea79399865458de18380186b794010c460fd4 [formerly 0f13ec6f6b58cc3176d204974595339b45069cf8]
Former-commit-id: 907f53386f006851ebe03779be396dd1aeb6ae0c
2016-02-10 09:21:24 -05:00
install Renamed things 2016-02-10 09:09:33 -05:00
ssl enable TLS as option 2016-02-07 10:20:41 -08:00
static Renamed things 2016-02-10 09:09:33 -05:00
templates Renaming 2016-02-10 09:13:21 -05:00
.gitignore Initial commit 2016-02-06 08:28:40 -05:00
db.go Renaming 2016-02-10 09:13:21 -05:00
LICENSE Initial commit 2016-02-06 08:28:40 -05:00
main.go Renaming 2016-02-10 09:21:24 -05:00
Makefile Finalized makefile and install instructions 2016-02-08 13:00:23 -05:00
README.md Updated readme 2016-02-10 09:03:24 -05:00
routes.go Renaming 2016-02-10 09:21:24 -05:00
utils.go Renaming 2016-02-10 09:21:24 -05:00
websockets.go Renaming 2016-02-10 09:13:21 -05:00

Logo

AwwKoala

A Websocket Wiki and Kind Of A List Application

Version 1.0 Go Report Card Join the chat at https://gitter.im/schollz/AwwKoala

This is a self-contained wiki webserver that makes sharing easy and fast. You can make any page you want, and any page is editable by anyone. Pages load instantly for editing, and have special rendering for whether you want to view as a web page or view as list.

Basics

To jot a note, simply load the page at / and just start typing. No need to press edit, the browser will already be focused on the text. No need to press save - it will automatically save when you stop writing. The URL at / will redirect to an easy-to-remember name that you can use to reload the page at anytime, anywhere. But, you can also use any URL you want, e.g. /AnythingYouWant.

Views and Lists

All pages can be rendered into HTML by adding /view. For example, the page /AnythingYouWant is rendered at /AnythingYouWant/view. You can write in HTML or Markdown for page rendering. Math is supported with Katex using $\frac{1}{2}$ for inline equations and $$\frac{1}{2}$$ for regular equations.

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.

Versioning

All previous versions of all notes are stored and can be accessed by adding ?version=X onto /view or /edit. If you are on the /view or /edit pages the menu below will show the most substantial changes in the history. Note, only the current version can be edited (no branching allowed, yet).

Disclaimer

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.

Contact

If you'd like help or find a bug, please submit an issue. Any other comments, quetions or anything at all, just tweet me @zack_118

Install

To get started on your local network just do:

git clone https://github.com/schollz/awwkoala.git
cd awwkoala
make
./awwkoala -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/awwkoala.git
cd awwkoala
nano Makefile <--- EDIT Makefile to include YOUR EXTERNAL ADDRESS
make && sudo make install

Now the program starts and stops with

sudo /etc/init.d/AwwKoala start|stop|restart

Edit your crontab (sudo crontab -e) to start on boot:

@reboot /etc/init.d/AwwKoala start

Usage

$ awwkoala --help
awwkoala: A Websocket Wiki and Kind Of A List Application
run this to start the server and then visit localhost at the port you specify
(see parameters).
Example: 'awwkoala localhost'
Example: 'awwkoala -p :8080 localhost'
Example: 'awwkoala -db /var/lib/awwkoala/db.bolt localhost'
Example: 'awwkoala -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/awwkoala/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")

If you set the admin flag, `-a` you can access a list of all the current files by going to `/ls/WhateverYouSetTheFlagTo`.