@tiddlywiki/mws 0.1.6 → 0.1.8
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 +7 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -47,10 +47,10 @@ Most of these features are still in development.
|
|
|
47
47
|
|
|
48
48
|
## How to run
|
|
49
49
|
|
|
50
|
-
The init command creates a new folder and installs what you need to get started.
|
|
50
|
+
The init command creates a new folder and installs what you need to get started. You can name "my-folder" whatever you want.
|
|
51
51
|
|
|
52
|
-
- `npm init @tiddlywiki/mws@latest
|
|
53
|
-
- `cd
|
|
52
|
+
- `npm init @tiddlywiki/mws@latest my-folder`
|
|
53
|
+
- `cd my-folder`
|
|
54
54
|
- `npx mws init-store`
|
|
55
55
|
- `npx mws listen --listener`
|
|
56
56
|
|
|
@@ -64,24 +64,24 @@ The initial user created on first run has the username `admin` and password `123
|
|
|
64
64
|
|
|
65
65
|
If you run into trouble, or need help figuring something out, feel free to [start a discussion](https://github.com/TiddlyWiki/MultiWikiServer/discussions). If you know what's wrong, you can also open an issue.
|
|
66
66
|
|
|
67
|
-
|
|
67
|
+
## Updates
|
|
68
68
|
|
|
69
69
|
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.
|
|
70
70
|
|
|
71
71
|
If updating within 0.1,
|
|
72
72
|
|
|
73
|
-
- Copy or zip your
|
|
73
|
+
- Copy or zip your entire folder to **a safe backup folder**.
|
|
74
74
|
- `npm install @tiddlywiki/mws@latest`
|
|
75
75
|
|
|
76
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.
|
|
77
77
|
|
|
78
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.
|
|
79
79
|
|
|
80
|
-
|
|
80
|
+
## Backups
|
|
81
81
|
|
|
82
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
83
|
|
|
84
|
-
|
|
84
|
+
## Development
|
|
85
85
|
|
|
86
86
|
In 0.1, the development data folder is `/dev/wiki`.
|
|
87
87
|
|