drirmbda / tw5-csencryption

Client-Side Encryption for TiddlyWiki5 on Node.js

TW5-CSEncryption

Client-Side Encryption for TiddlyWiki5 on Node.js

Features

• Configure a master password for TiddlyWiki5 on Node.js, and automatically encrypt tiddlers once it leaves the browser.
• Compatible with and interacts with EncryptTiddler, supports using EncryptTiddler for encryption again internally, and the encrypted file can be decrypted using EncryptTiddler.
• Use the same encryption library as EncryptTiddler, which is the SJCL built into TW5, and the default encryption method is AES-CCM 128.
• Supports modifying and clearing passwords, supports modifying Filters, and instantly pushes the changes to the server.

Architecture Overview

Documentation

For more information, please see: TW5-CSEncryption — Client-Side Encryption for TiddlyWiki5 on Node.js

Development

git clone https://github.com/FSpark/TW5-CSEncryption
cd TW5-CSEncryption
pnpm i

# Since I modified the scaffolding (gulp-tw) myself but didn't publish it to NPM, please install the dependencies like this:

cd <another_folder>
git clone https://github.com/FSpark/gulp-tw
cd TW5-CSEncryption
pnpm link <another_folder>/gulp-tw
pnpm run dev

# Enjoy :)