@tiddlywiki/mws 0.1.13 → 0.2.0

package/README.md

@@ -23,13 +23,25 @@ Multiple users, multiple wikis for TiddlyWiki.
 
 Most of these features are still in development.
 
-**Do not use it to protect feelings or intellectual property.**
+## Here's a sneak peak at the new UI that's coming
+
+### Dark Mode
+
+<img width="800" alt="light mode" src="https://github.com/user-attachments/assets/d2c8177a-e504-4bff-999d-4b260467ac2e" />
+
+### Light Mode
+
+<img width="800" alt="dark mode" src="https://github.com/user-attachments/assets/301cb61c-1f39-4d4f-8f4a-8ecd5306c084" />
+
+## Warning: Security between users is still a dumpster fire.
 
-## Warning: Security is still a dumpster fire.
+**While the database structure is reliable, the security mechanism is more like swiss cheese.**
 
-**While the database structure is reliable, the security mechanism isn't. Do not use it to protect feelings or intellectual property. There are still ways to easily get around the security restrictions.**
+**Do not use it to protect feelings or intellectual property.**
+
+**There are plenty of ways for anyone with write access to get around the security restrictions.**
 
-![this is fine](https://github.com/user-attachments/assets/49505d25-7a48-42f1-b4f7-73e8630c1ba1)
+<img width="800" alt="this is fine" src="https://github.com/user-attachments/assets/49505d25-7a48-42f1-b4f7-73e8630c1ba1" />
 
 
 ## Also, this is a database, please make backups
@@ -42,13 +54,12 @@ The init command creates a new folder and installs what you need to get started.
 
 - `npm init @tiddlywiki/mws@latest my-folder`
 - `cd my-folder`
-- `npx mws init-store`
 - `npx mws listen --listener`
 
 You can run `npx mws help` to get more information about the commands. 
 
 - the server runs on port `8080`. It does not use HTTPS by default, but you can enable it by specifying a key and cert.
-- A `passwords.key` file is created which contains the password master salt. If this file changes, all passwords will need to be reset.
+- A `passwords.key` file is created which contains the password master salt. If this file changes, all passwords will become unusable and need to be reset.
 - Your database is in the `store` folder. All files in the `store` folder are data files, not temp or lock files! Never delete them! 
 
 The initial user created on first run has the username `admin` and password `1234`.
@@ -57,38 +68,48 @@ If you run into trouble, or need help figuring something out, feel free to [star
 
 ## Updates
 
-If upgrading from 0.0, the best way to save your information is to open each wiki and click the cloud status icon, then click "save snapshot for offline use". You can then create a new instance and import your wikis via the browser.
+Within 0.x versions, please do NOT use `npm install` to update your instance from one minor version to the next.
 
-If updating within 0.1,
+To update between 0.x versions, open each wiki and click the cloud status icon, then click "save snapshot for offline use". You can then create a new instance and import your wikis via the browser. 
 
-- Copy or zip your entire folder to **a safe backup folder**.
-- `npm install @tiddlywiki/mws@latest`
+_Always, always, always save a backup of your store folder before updating._
 
-If there are any database changes, MWS should pick them up and apply them on startup. The changes are generated by prisma's builtin migration and are supposed to preserve data, but backups are still highly recommended.
+### Starting with 0.2
 
-The 0.1 database is incompatible with the 0.0 database. Version 0.1 will detect this and exit immediately to prevent data loss.
+- You can update to the latest version of MWS using `npm update`. 
+- You can update to the latest version of tiddywiki using `npx mws update-tiddlywiki`. 
+
+If there are any database changes, MWS should pick them up and apply them on startup. The changes are generated by prisma's builtin migration and are supposed to preserve data, but backups are still highly recommended.
 
 ## Backups
 
-It is recommended to backup your entire data folder, not just the `store` folder, except the `cache` folder. 
+It is recommended to backup your entire data folder, not just the `store` folder, with a few exceptions. 
 
 - You must *always* backup the *entire* `store` folder. Never delete any files in the `store` folder. All files in the `store` folder are data files!
-- You should definitely backup the `package.json` file, as it contains the MWS version you are currently using. The `package-lock.json` file is also useful if you don't want to back up the entire `node_modules` folder for some reason. 
-- The `cache` folder (next to the `store` folder) is generated every time MWS starts, so you can exclude that from backups if you want. 
-- The `node_modules` folder should be included in your backup, as it contains all the application code required to run your database, but it can also be reconstructed from the `package-lock.json` file or the `package.json` file. 
-
-MWS uses NPM packages, so as long as you back up the *entire* store folder, and the package-lock.json file, you should have enough information for a NodeJS developer to reconstruct the site. 
+- `passwords.key` can be backed up, but since it never changes you could also just save a copy of it in a more secure location separate from your normal backups.
+- You should backup `package.json` and `package-lock.json`.
+- The `node_modules` folder can be ignored. `npm ci` will reinstall the `node_modules` folder based on `package-lock.json`.
+- The `cache` folder (next to the `store` folder) is generated every time MWS starts, so it's nothing but bloat. You can always ignore it.
+- Only the `tw5/versions.txt` file needs to be saved from the `tw5` folder.
+
+So essentially, the paths you need to backup are:
+- `/package.json`
+- `/package-lock.json`
+- `/store`
+- `/tw5/versions.txt`
+- `/passwords.key` (or save it separately)
 
 ## Development
 
-In 0.1, the development data folder is `/dev/wiki`.
+In 0.2, the development data folder is `/dev/wiki`.
 
-If you want to work on the project,
+If you want to work on the project, or just try out the latest changes,
 
 - `git clone https://github.com/TiddlyWiki/MultiWikiServer`
 - `cd MultiWikiServer`
 - `npm install` or `npm run install-android`
 - `npm run certs` - if you want https (unix only)
+- `npm start update-tiddlywiki` - Download the latest TiddlyWiki version
 - `npm start init-store` - Create the `admin` user and import default wikis.
 - `npm start` - this will run the build every time, but it's very fast.