@tiddlywiki/mws 0.1.1 → 0.1.3
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 +19 -24
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,25 +1,22 @@
|
|
|
1
|
-
|
|
2
1
|
# MultiWikiServer
|
|
3
2
|
|
|
3
|
+
<a href="https://www.paypal.com/donate/?hosted_button_id=BVDDREGEU2ZEA">
|
|
4
|
+
<img src="https://github.com/user-attachments/assets/6467378f-26fd-40ff-b60e-b8d62555c08a" width="20" />
|
|
5
|
+
Donate via PayPal
|
|
6
|
+
</a>
|
|
4
7
|
|
|
5
|
-
[
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
In its early stages, MWS is largely being developed by me, [Arlen22](https://github.com/Arlen22), based on input from the TiddlyWiki community at large, as well as my own experience with TiddlyWiki. I am a freelance software developer, so I can allocate time as needed, but that cuts into other work I could be doing. If you'd like to support my work on MWS, feel free to donate. It very directly allows me to put more time into this project. I've worked on several similar projects in the past, so this project is one I am quite passionate about, and I consider it a privelage to be able to do this.
|
|
10
|
-
|
|
11
|
-
|
|
8
|
+
In its early stages, MWS is largely being developed by me, [Arlen22](https://github.com/Arlen22), based on input from the TiddlyWiki community at large, as well as my own experience with TiddlyWiki. I am a freelance software developer, so I can allocate time as needed, but that cuts into other work I could be doing. If you'd like to support my work on MWS, feel free to donate. It very directly allows me to put more time into this project. I've worked on several similar projects in the past, so this project is one I am quite passionate about, and I consider it a privelage to be able to do this.
|
|
12
9
|
|
|
13
10
|
## Warning
|
|
11
|
+
|
|
14
12
|
<div style="width:48px"></div>
|
|
15
13
|
<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 48 48"><g clip-path="url(#a)"><path fill="#002991" d="M38.914 13.35c0 5.574-5.144 12.15-12.927 12.15H18.49l-.368 2.322L16.373 39H7.056l5.605-36h15.095c5.083 0 9.082 2.833 10.555 6.77a9.687 9.687 0 0 1 .603 3.58z"/><path fill="#60CDFF" d="M44.284 23.7A12.894 12.894 0 0 1 31.53 34.5h-5.206L24.157 48H14.89l1.483-9 1.75-11.178.367-2.322h7.497c7.773 0 12.927-6.576 12.927-12.15 3.825 1.974 6.055 5.963 5.37 10.35z"/><path fill="#008CFF" d="M38.914 13.35C37.31 12.511 35.365 12 33.248 12h-12.64L18.49 25.5h7.497c7.773 0 12.927-6.576 12.927-12.15z"/></g><defs><clipPath id="a"><path fill="#fff" d="M7.056 3h37.35v45H7.056z"/></clipPath></defs></svg>
|
|
16
14
|
|
|
17
|
-
|
|
18
15
|
**This is not ready for primetime. Do not use it to protect feelings or intellectual property. Seriously. The security mechanisms required are not built yet.**
|
|
19
16
|
|
|
20
|
-
|
|
17
|
+
_So please try it out, kick the tires, import your multi-gigabyte wikis and play around with it, but don't actually store anything you want to keep. We'll hopefully get there soon, but even the database schema itself is still in flux as we figure out what the best layout is for all the stuff we have planned._
|
|
21
18
|
|
|
22
|
-
## Security is still a dumpster fire.
|
|
19
|
+
## Security is still a dumpster fire.
|
|
23
20
|
|
|
24
21
|
|
|
25
22
|
|
|
@@ -29,9 +26,9 @@ Storing data is safe enough, sort of, but upgrading to new versions is where the
|
|
|
29
26
|
|
|
30
27
|
## Also, this is a database, please make backups
|
|
31
28
|
|
|
32
|
-
Seriously, you never know. Databases try very hard to be perfect, and a small number of database engines run the entire internet, so there are a lot of eyes on them, and data bugs are rare. But that doesn't mean things can't go wrong. Backups are critical.
|
|
29
|
+
Seriously, you never know. Databases try very hard to be perfect, and a small number of database engines run the entire internet, so there are a lot of eyes on them, and data bugs are rare. But that doesn't mean things can't go wrong. Backups are critical.
|
|
33
30
|
|
|
34
|
-
|
|
31
|
+
---
|
|
35
32
|
|
|
36
33
|
Multiple users, multiple wikis for TiddlyWiki.
|
|
37
34
|
|
|
@@ -40,20 +37,20 @@ Multiple users, multiple wikis for TiddlyWiki.
|
|
|
40
37
|
- Multiple database engines supported, using Prisma.
|
|
41
38
|
- Third-party OAuth and password-based login.
|
|
42
39
|
|
|
43
|
-
## Flexible and Extendible
|
|
40
|
+
## Flexible and Extendible
|
|
44
41
|
|
|
45
42
|
- Plugins can add routes and hooks.
|
|
46
43
|
- Abstractions everywhere, allowing flexibility.
|
|
47
44
|
- The source code is fully typed and easy to navigate.
|
|
48
45
|
- Admin endpoints can also be called from the CLI.
|
|
49
46
|
|
|
50
|
-
Most of these features are still in development.
|
|
47
|
+
Most of these features are still in development.
|
|
51
48
|
|
|
52
49
|
**Do not use it to protect feelings or intellectual property.**
|
|
53
50
|
|
|
54
51
|
## How to run
|
|
55
52
|
|
|
56
|
-
The init command creates a new folder and installs what you need to get started.
|
|
53
|
+
The init command creates a new folder and installs what you need to get started.
|
|
57
54
|
|
|
58
55
|
- `npm init @tiddlywiki/mws@latest mws`
|
|
59
56
|
- `cd mws`
|
|
@@ -61,8 +58,8 @@ The init command creates a new folder and installs what you need to get started.
|
|
|
61
58
|
|
|
62
59
|
You can customize the defaults by modifying `mws.run.mjs`.
|
|
63
60
|
|
|
64
|
-
- the server runs on port `8080`. It does not use HTTPS by default, but you can enable it by specifying a key and cert.
|
|
65
|
-
- A `localpass.key` file is created to hold the password keyfile. If this file changes, all passwords will need to be reset.
|
|
61
|
+
- the server runs on port `8080`. It does not use HTTPS by default, but you can enable it by specifying a key and cert.
|
|
62
|
+
- A `localpass.key` file is created to hold the password keyfile. If this file changes, all passwords will need to be reset.
|
|
66
63
|
- The data folder (`wikiPath`) is `wiki` by default.
|
|
67
64
|
|
|
68
65
|
The initial user created on first run has the username `admin` and password `1234`.
|
|
@@ -71,7 +68,7 @@ If you run into trouble, or need help figuring something out, feel free to [star
|
|
|
71
68
|
|
|
72
69
|
### Updates
|
|
73
70
|
|
|
74
|
-
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.
|
|
71
|
+
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.
|
|
75
72
|
|
|
76
73
|
If updating within 0.1,
|
|
77
74
|
|
|
@@ -85,19 +82,17 @@ The 0.1 database is incompatible with the 0.0 database. Version 0.1 will detect
|
|
|
85
82
|
|
|
86
83
|
### Development
|
|
87
84
|
|
|
88
|
-
In 0.1, the data folder is `/dev/wiki`.
|
|
85
|
+
In 0.1, the data folder is `/dev/wiki`.
|
|
89
86
|
|
|
90
|
-
If you want to work on the project,
|
|
87
|
+
If you want to work on the project,
|
|
91
88
|
|
|
92
89
|
- `git clone https://github.com/TiddlyWiki/MultiWikiServer`
|
|
93
90
|
- `cd MultiWikiServer`
|
|
94
91
|
- `npm install` or `npm run install-android`
|
|
95
92
|
- `npm run certs` - if you want https (unix only)
|
|
96
93
|
- `npm start init-store` - Create the `admin` user and import default wikis.
|
|
97
|
-
- `npm start` - this will run the build every time, but it's very fast.
|
|
94
|
+
- `npm start` - this will run the build every time, but it's very fast.
|
|
98
95
|
|
|
99
96
|
The development wiki will be active at http://localhost:8080/dev
|
|
100
97
|
|
|
101
98
|
You can change the listeners as explained in the mws.dev.mjs file.
|
|
102
|
-
|
|
103
|
-
|