Getting help and providing feedback

The best place to get in touch is the TiddlyWikiClassic google group. Bugs and feature requests should also become GH issues but usually it's better to write to the google group first.

Contributing

Any contributions are greatly appreciated. What you can do for the project:

  • help creating a minimal-efforts installer of a win/*nix bundle (server + MTS)
  • help creating better password protection: stronger, server- and OS-independent (suggest a lib if you know a good one or help implement)
  • help implement saving for TiddlyWiki5
  • architecture and best practices suggestions are welcome;
    please keep in mind that one-file approach is used to simplify installation
  • examine security of MTS (in an issue, just let me know there's a security problem, and we'll find a way to contact and discuss it privately)
  • thank/donate to encourage further development

To contribute to the code you may either start with a conversation in the google group or create a pull request directly at GitHub but please make sure it's clear what issue you are dealing with.

Perspectives

Several distinct features that are planned/considered to be implemented:

  • planned: collaborative editing (avoid conflicts, show changes on the go);
  • planned/semi-implemented: image uploading (insert from clipboard etc);
  • to be considered: better backuping? (see discussion and this strategy)
  • to be considered: support extended filesystem operations (for things like saveAs, snapshots, saving RSS);
  • to be considered: integration with git and sync between devices or online/offline TW instances;
  • to be considered: update engine, plugin system;
  • password protection system is also likely to get improved.

Support of TiddlyWiki5 is discussable but somewhat unlikely until somebody helps me with its core engine (what JS to hijack, saving format etc).

For other requests, please contact me like described above.

Author and license

MainTiddlyServer is a fork of MicroTiddlyServer which in turn is a fork of MiniTiddlyServer. MainTiddlyServer is developed by Yakov Litvin (versions 1.0.0-1.5.2 were released as "MicroTiddlyServer" with the "_YL" suffix in the code comments).

MainTiddlyServer is MIT-licensed which means you can use (or change) it practically any way you want. It is free and open-source.

Credits

This project wouldn't exist without TiddlyWiki itself, so special thanks to Jeremy Ruston, the author of TW, and other developers who contributed to the core of TiddlyWiki Classic and various plugins for it.

MainTiddlyServer wasn't built from scratch, and some credits should definitely go to Athman, the author of the MicroTiddlyServer fork, and to the author of the original MiniTiddlyServer who is sadly unknown to me.

Last but no least, I'd like to thank the whole TiddlyWiki community for all the discussions, inspiration and encouragement brought through the google groups.