0b2928468b
Former-commit-id: 09543cf9d15b734ed48d24eb2fe30ad2ecc96cbb [formerly 793f2ff37d1dea630bd254643372c25f64603ff5] [formerly b4d60e8cd53aad403d8d0d7bf6324fb95631ebbd [formerly 6b526e4327]]
Former-commit-id: f1d0cc3a5199cfccab35243e9b6d75de3935f9fa [formerly bd9c741701aecb0a99a23e64b9c5a34e199281fb]
Former-commit-id: 56d6dcb02e92b18d69c2a1fdbb404be01bfa3ee7
4.4 KiB
AwwKoala
A Websocket Wiki and Kind Of A List Application
This is a self-contained wiki webserver that makes sharing easy and fast. The most important feature here is simplicity. There are many other features as well including versioning, page locking, self-destructing messages, encryption, math support, and listifying. Read on to learn more about the features. AwwKoala is also Open Source.
Features
Simplicity. The philosophy here is to just type. 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. 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. To quickly link to /view pages, just use [[AnythingYouWnat]].
Listifying. 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 struck through and moved to the end. This is helpful if you write a grocery list and then want to easily delete things from it.
Automatic 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).
Self-destructing messages. You can write a message that will delete itself when a user loads it (in any view). Useful for transmitting sensitive information. To use, simply add a line somewhere that says only "self-destruct".
Security. HTTPS support is provided and everything is sanitized to prevent XSS attacks. Though all URLs are publicly accessible, you are free to obfuscate your website by using an obscure/random address (read: the site is still publicly accessible, just hard to find!). In addition to TLS support, you can PGP-encrypt your messages using a passphrase.
Page locking. You can apply a password to a page to allow further edits from being available. The whole version tree will still be available. Note: This is not available for list mode.
Keyboard Shortcuts. Quickly transition between Edit/View/List by using Ctl+Shift+E to Edit, Ctl+Shift+Z to View, and Ctl+Shift+L to Listify.
Admin controls. The Admin can view/delete all the documents by setting the -a YourAdminKey when starting the program. Then the admin has access to the /ls/YourAdminKey to view and delete any of the pages.
Math support. Math is supported with Katex using $\frac{1}{2}$ for inline equations and $$\frac{1}{2}$$ for regular equations.
Contact
Any other comments, questions or anything at all, just tweet me @zack_118
Have fun.
Powered by Raspberry Pi, Go, and NGINX
