mirror/cowyo
1
0
Fork 0
mirror of https://github.com/schollz/cowyo.git synced 2023-08-10 21:13:00 +03:00
Code Issues Projects Releases Wiki Activity
411 Commits 4 Branches 25 Tags 38 MiB
Go 91.5%
JavaScript 7.5%
CSS 0.9%
b3b5f31575
Go to file
Zack Scholl b3b5f31575 Bump version
2017-09-30 09:18:30 -04:00
encrypt Moved the encryption to its own package 2017-06-29 15:24:34 -06:00
static Updated logo and README 2017-03-23 19:23:33 -06:00
templates Add recent pages to "view" 2017-09-29 08:48:32 -04:00
.gitattributes Create .gitattributes 2016-03-15 20:51:09 -04:00
.gitignore Initial commit 2016-02-06 08:28:40 -05:00
.travis.yml Update .travis.yml 2017-03-23 19:30:24 -06:00
bindata.go Add recent pages to "view" 2017-09-29 08:48:32 -04:00
handlers.go Skip icons in the recent files 2017-09-29 12:21:10 -04:00
LICENSE Start again from scratch 2017-03-22 20:49:55 -06:00
listify.go List works 2017-03-22 11:19:39 -06:00
main.go Spelling 2017-06-23 13:02:56 -06:00
Makefile Remove upx for now 2017-08-18 07:05:10 -07:00
migrate.go Reorganize and add migration 2017-03-21 21:51:52 -06:00
page_test.go Moved the encryption to its own package 2017-06-29 15:24:34 -06:00
page.go Use meta instead of storing in history 2017-08-17 07:36:07 -07:00
README.md Bump version 2017-09-30 09:18:30 -04:00
utils_test.go Moved the encryption to its own package 2017-06-29 15:24:34 -06:00
utils.go Moved the encryption to its own package 2017-06-29 15:24:34 -06:00

README.md

linkcrawler
Build Status Version

A feature-rich wiki for minimalists

cowyo is a self-contained wiki server that makes jotting notes easy and fast. The most important feature here is simplicity. Other features include versioning, page locking, self-destructing messages, encryption, and listifying. You can download cowyo as a single executable or install it with Go. Try it out at https://cowyo.com.

There is now a command-line tool, cowyodel to interact with cowyo and transfer information between computers with only a code phrase: schollz/cowyodel.

Getting Started

Install

If you have go

go get -u github.com/schollz/cowyo/...

or just download the latest release.

Run

To run just double click or from the command line:

cowyo

and it will start a server listening on 0.0.0.0:8050. To view it, just go to http://localhost:8050 (the server prints out the local IP for your info if you want to do LAN networking). You can change the port with -port X, and you can listen only on localhost using -host localhost.

Running with TLS

Specify a matching pair of SSL Certificate and Key to run cowyo using https. cowyo will now run in a secure session.

N.B. Let's Encrypt is a CA that signs free and signed certificates.

cowyo --cert "/path/to/server.crt" --key "/p/t/server.key"

Usage

cowyo is straightforward to use. Here are some of the basic features:

Editing

When you open a document you'll be directed to an alliterative animal (which is supposed to be easy to remember). You can write in Markdown. Saving is performed as soon as you stop writing. You can easily link pages using PageName as you edit.

Editing

History

You can easily see previous versions of your documents.

History

Lists

You can easily make lists and check them off.

Lists

Locking

Locking prevents other users from editing your pages without a passphrase.

Locking

Encryption

Encryption is performed using AES-256.

Encryption

Self-destructing pages

Just like in mission impossible.

Self-destructing

Development

You can run the tests using

$ cd $GOPATH/src/github.com/schollz/cowyo
$ go test ./...

Any contributions are welcome.

License

MIT