@tiddlywiki/mws 0.1.4 → 0.1.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 +9 -6
- package/dist/metafile-esm.json +1 -1
- package/dist/mws.js +3 -2
- package/dist/mws.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -50,15 +50,15 @@ Most of these features are still in development.
|
|
|
50
50
|
The init command creates a new folder and installs what you need to get started.
|
|
51
51
|
|
|
52
52
|
- `npm init @tiddlywiki/mws@latest mws`
|
|
53
|
-
- `cd mws`
|
|
53
|
+
- `cd mws` - this is your data folder
|
|
54
54
|
- `npx mws init-store`
|
|
55
55
|
- `npx mws listen --listener`
|
|
56
56
|
|
|
57
|
-
You can
|
|
57
|
+
You can run `npx mws help` to get more information about the commands.
|
|
58
58
|
|
|
59
59
|
- the server runs on port `8080`. It does not use HTTPS by default, but you can enable it by specifying a key and cert.
|
|
60
60
|
- A `localpass.key` file is created to hold the password keyfile. If this file changes, all passwords will need to be reset.
|
|
61
|
-
- The
|
|
61
|
+
- The database is in the store folder. Backups MUST save the entire store folder. All files are critically important. They are not temp files.
|
|
62
62
|
|
|
63
63
|
The initial user created on first run has the username `admin` and password `1234`.
|
|
64
64
|
|
|
@@ -72,15 +72,18 @@ If updating within 0.1,
|
|
|
72
72
|
|
|
73
73
|
- Copy or zip your `store` folder to **a safe backup folder**.
|
|
74
74
|
- `npm install @tiddlywiki/mws@latest`
|
|
75
|
-
- Run `npm start`. This will update the database schema automatically if there are new changes.
|
|
76
75
|
|
|
77
|
-
If there are any database changes, MWS should pick them up and apply them. The changes are generated by prisma's builtin migration and are supposed to preserve data, but backups are still highly recommended.
|
|
76
|
+
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.
|
|
78
77
|
|
|
79
78
|
The 0.1 database is incompatible with the 0.0 database. Version 0.1 will detect this and exit immediately to prevent data loss.
|
|
80
79
|
|
|
80
|
+
### Backups
|
|
81
|
+
|
|
82
|
+
It is recommended to backup your entire data folder, not just the `store` folder. However, 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 definitely be included in your backup, as it contains all the application code required to run your database.
|
|
83
|
+
|
|
81
84
|
### Development
|
|
82
85
|
|
|
83
|
-
In 0.1, the data folder is `/dev/wiki`.
|
|
86
|
+
In 0.1, the development data folder is `/dev/wiki`.
|
|
84
87
|
|
|
85
88
|
If you want to work on the project,
|
|
86
89
|
|