widdler/README.md

49 lines
1.0 KiB
Markdown
Raw Normal View History

2021-05-17 08:01:47 -06:00
widdler
=======
widdler is a single binary that serves up
[TiddlyWiki](https://tiddlywiki.com)s.
It can be used to server existing wikis, or to create new ones.
2021-05-20 06:26:49 -06:00
# Features
- TiddlyWikis are served over WebDav so you can save directly from the browser.
- Automatically create new wiki files by browsing to a non-existent html file.
2021-05-20 06:48:58 -06:00
- Built in .htpasswd management (Adding users).
2021-05-20 06:28:11 -06:00
- Password protection via HTTP Basic Authentication.
2021-05-20 06:26:49 -06:00
- Multiple users (adding another user to the .htaccess file creates a new user
namespace).
- Optional TLS support.
2021-05-19 21:20:12 -06:00
2021-05-17 08:01:47 -06:00
# Installation
```
go get -u suah.dev/widdler
```
# Running
```
mkdir wiki
cd wiki
# Generate a .htpasswd file:
widdler -gen
Username: qbit
Passwd: ******
# Start the server
./widdler
2021-05-17 08:01:47 -06:00
```
2021-05-19 21:20:12 -06:00
Now open your browser to [http://localhost:8080](http://localhost:8080).
2021-05-17 16:04:56 -06:00
2021-05-17 08:01:47 -06:00
# Creating a new TiddlyWiki
Simply browse to the file name you wish to create. widdler will automatically
create the wiki file based off the current `empty.html` TiddlyWiki version.
# Saving changes
Simply hit the save button!