@tiddlywiki/mws 0.2.4 → 0.2.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -27
- package/dist/metafile-esm.json +1 -1
- package/dist/mws.js +8237 -7529
- package/dist/mws.js.map +1 -1
- package/mws.run.mjs +2 -40
- package/package.json +3 -2
- package/plugins/client/src/new-multiwikiclientadaptor.ts +1 -1
- package/plugins/client/tiddlers/syncer/new-multiwikiclientadaptor.js +2 -2
- package/public/admin-vanilla/{main-Z66TEMIJ.js → main-PEJXZ4DB.js} +13 -13
- package/public/admin-vanilla/main-PEJXZ4DB.js.map +7 -0
- package/public/admin-vanilla.html +7 -7
- package/public/admin-vanilla.json +1 -1
- package/public/{admin-vanilla/site.webmanifest → admin-vanilla.webmanifest} +3 -3
- package/scripts/scripts.mjs +2 -2
- package/public/admin-vanilla/main-Z66TEMIJ.js.map +0 -7
package/README.md
CHANGED
|
@@ -14,39 +14,22 @@ Multiple users, multiple wikis for TiddlyWiki.
|
|
|
14
14
|
- Multiple database engines supported, using Prisma.
|
|
15
15
|
- Third-party OAuth and password-based login.
|
|
16
16
|
|
|
17
|
-
## Flexible and Extendible
|
|
18
17
|
|
|
19
|
-
|
|
20
|
-
- Abstractions everywhere, allowing flexibility.
|
|
21
|
-
- The source code is fully typed and easy to navigate.
|
|
22
|
-
- Admin endpoints can also be called from the CLI.
|
|
18
|
+
## Security
|
|
23
19
|
|
|
24
|
-
|
|
20
|
+
Security is a core priority.
|
|
25
21
|
|
|
26
|
-
|
|
22
|
+
- MWS supports HTTPS through Node.js. We strongly recommend enabling it.
|
|
23
|
+
- MWS uses OPAQUE for password-based authentication, so users' plaintext passwords are never sent to the server.
|
|
24
|
+
- Role-based access controls let you grant users access to individual wikis.
|
|
27
25
|
|
|
28
|
-
|
|
26
|
+
***One Caveat:*** Currently, the security for users with write access is minimal. Having write access to even one wiki makes it possible to craft code that impersonates other users and reads or writes data they have access to.
|
|
29
27
|
|
|
30
|
-
|
|
28
|
+
## Data Integrity
|
|
31
29
|
|
|
32
|
-
|
|
30
|
+
We rely on established database technology to help protect data integrity. MWS currently uses SQLite, and we are planning to support more database engines in the future.
|
|
33
31
|
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
## Warning: Security between users is still a dumpster fire.
|
|
37
|
-
|
|
38
|
-
**While the database structure is reliable, the security mechanism is more like swiss cheese.**
|
|
39
|
-
|
|
40
|
-
**Do not use it to protect feelings or intellectual property.**
|
|
41
|
-
|
|
42
|
-
**There are plenty of ways for anyone with write access to get around the security restrictions.**
|
|
43
|
-
|
|
44
|
-
<img width="800" alt="this is fine" src="https://github.com/user-attachments/assets/49505d25-7a48-42f1-b4f7-73e8630c1ba1" />
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
## Also, this is a database, please make backups
|
|
48
|
-
|
|
49
|
-
Databases try very hard to be perfect, and data bugs are rare. But that doesn't mean things can't go wrong. Backups are pretty important.
|
|
32
|
+
***Remember:*** Your database files are stored in your wiki folder. Back up the folder regularly.
|
|
50
33
|
|
|
51
34
|
## How to run
|
|
52
35
|
|
|
@@ -77,7 +60,7 @@ _Always, always, always save a backup of your store folder before updating._
|
|
|
77
60
|
### Starting with 0.2
|
|
78
61
|
|
|
79
62
|
- You can update to the latest version of MWS using `npm update`.
|
|
80
|
-
- You can update to the latest version of
|
|
63
|
+
- You can update to the latest version of TiddlyWiki using `npx mws update-tiddlywiki`.
|
|
81
64
|
|
|
82
65
|
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.
|
|
83
66
|
|