Go to file
Aaron Bieber e3b3dad3ee clean our passPath for good measure 2021-12-10 15:50:28 -07:00
.gitignore add goreleaser config 2021-12-10 15:49:29 -07:00
.goreleaser.yml add goreleaser config 2021-12-10 15:49:29 -07:00
LICENSE initial 2021-05-17 07:50:45 -06:00
README.md Fix typo 2021-12-08 21:11:22 -05:00
empty-5.2.1.html update TW to 5.2.1 2021-12-09 06:28:37 -07:00
go.mod switch to term package 2021-12-10 15:49:52 -07:00
go.sum tidy 2021-12-10 06:26:31 -07:00
main.go clean our passPath for good measure 2021-12-10 15:50:28 -07:00

README.md

widdler

widdler is a single binary that serves up TiddlyWikis.

It can be used to serve existing wikis, or to create new ones.

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.
  • Built in .htpasswd management (Adding users).
  • Password protection via HTTP Basic Authentication.
  • Multiple users (adding another user to the .htaccess file creates a new user namespace).
  • Optional TLS support.

Installation

For Go 1.16:

go get -u suah.dev/widdler

For Go 1.17 and up:

go install suah.dev/widdler@latest

Running

mkdir wiki
cd wiki
# Generate a .htpasswd file:
widdler -gen
Username: qbit
Passwd: ******
# Start the server
./widdler

Now open your browser to http://localhost:8080.

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!

Updating widdler

go install suah.dev/widdler@latest

Running without .htpasswd

You can disable auth all together by setting the -auth flag to false:

widdler -auth=false -wikis ~/wiki