hffqyd/tw5-server

A protable local server for TiddlyWiki5 that saves and backups wiki.

tw5-server

A local server for TiddlyWiki5 that saves and backups wikis, inspired by tw5-server.rb.

tw5-server is written in Nim, provides features of:

• Server for TiddlyWiki5, as well as other files (e.g. images used in TW5 [img[images/*.png]]).
• Easy to save wiki via browsers.
• Upload images/files for using in TiddlyWiki5 via press button or drag-and-drop.
• Backup wiki in compressed format (.gz), to save disk space.
• Auto clean backups: keep the last one for previous months, keep all backups in current month.
• Offer binary executable for Linux, macos, Android and windows.

Usage

Download binary executable for your operating system from github release, and run in your terminal (in Termux or other terminals if using Android).

tw5server -a:192.168.0.10 -p:8000 -d:./ -b:backup

-h usage help
-a address, defautl localhost
-p port, default 8000
-d directory to servering, default `current dir`
-b backup directory name, default `backup`
-l log saving messages to stdout

Backups auto-clean strategy:
Keep all backups in current month, keep only the newest one for previous months.

Then go to http://localhost:8000 (or other address:port specified in command) in your web browser, and click on your wiki html file.

Upload example

1. Upload images/files (e.g. to an images directory) for use within TiddlyWiki5 (e.g. [img[images/some.png]]): Browse a file, check if to overwrite and submit, saving message will be on the right.

2. Upload images/files via drag-and-drop: Drag a file to tw5-server page (the border will show when draging), and drop.

tw5-server's Issues

Trying to compile tw5server for apple silicon but getting a dependency error

Hi, I downloaded the latest source zip of the latest release but am getting some dependency errors when trying to compile: (see below).

All suggestions welcome.
Thank you.

$ nim c --cpu:arm64 --os:macosx tw5server.nim
Hint: used config file '/usr/local/Cellar/nim/2.0.2/nim/config/nim.cfg' [Conf]
Hint: used config file '/usr/local/Cellar/nim/2.0.2/nim/config/config.nims' [Conf]
..................................................................................................................................................
/Users/xxxx/Downloads/tmp/tw5-server-1.2.1/tw5server.nim(12, 3) Error: cannot open file: zippy
$ which nimble
/usr/local/bin/nimble
$ nimble install zippy
    Prompt: No local packages.json found, download it from internet? [y/N]
    Answer: y
Downloading Official package list
    Success Package list downloaded.
Downloading https://github.com/guzba/zippy using git
  Verifying dependencies for [email protected]
 Installing [email protected]
  Success:  zippy installed successfully.
$ nim c --cpu:arm64 --os:macosx tw5server.nim
Hint: used config file '/usr/local/Cellar/nim/2.0.2/nim/config/nim.cfg' [Conf]
Hint: used config file '/usr/local/Cellar/nim/2.0.2/nim/config/config.nims' [Conf]
...................................................................................................................................................................
/Users/xxxx/Downloads/tmp/tw5-server-1.2.1/tw5server.nim(18, 6) Error: cannot open file: parseBody
$ 

Hosting on nginx webserver

Hello,

I've tried hosting this on nginx with the config:

location /wiki {
  proxy_pass http://127.0.0.1:10123/;
}

I used the command tw5server -p10123 to run the tw5 server, but I get 502 bad gateway. In my nginx logs I see:

2023/06/01 20:42:38 [error] 19183#19183: *149 connect() failed (111: Connection refused) while connecting to upstream, client: 192.redacted.server.ip, server: redacted.url, request: " GET /wiki HTTP/1.0", upstream: "http://127.0.0.1:10123/", host: "redacted.url"

Do you have any idea why this might be?