@rhost/server 1.6.2
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 +48 -0
- package/bin.js +2 -0
- package/package.json +36 -0
package/README.md
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# @rhost/server
|
|
2
|
+
|
|
3
|
+
Zero-config RhostMUSH Docker server. Pull, configure, and start in one command.
|
|
4
|
+
|
|
5
|
+
```sh
|
|
6
|
+
npx @rhost/server init # scaffold config
|
|
7
|
+
npx @rhost/server start # start the server
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
This is a thin CLI wrapper around [@rhost/testkit](https://www.npmjs.com/package/@rhost/testkit).
|
|
11
|
+
All options and documentation live there.
|
|
12
|
+
|
|
13
|
+
## Quick start
|
|
14
|
+
|
|
15
|
+
```sh
|
|
16
|
+
# Scaffold a new server directory
|
|
17
|
+
npx @rhost/server init my-mush
|
|
18
|
+
|
|
19
|
+
# With WebSocket and stunnel TLS
|
|
20
|
+
npx @rhost/server init my-mush --websocket --stunnel
|
|
21
|
+
|
|
22
|
+
# Start (uses defaults — pulls lcanady/rhostmush:latest)
|
|
23
|
+
cd my-mush
|
|
24
|
+
npx @rhost/server start
|
|
25
|
+
|
|
26
|
+
# Start with custom port
|
|
27
|
+
npx @rhost/server start --port 7000
|
|
28
|
+
|
|
29
|
+
# Build from source with WebSocket enabled
|
|
30
|
+
npx @rhost/server start --build-from-source --enable-websockets
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Commands
|
|
34
|
+
|
|
35
|
+
| Command | Description |
|
|
36
|
+
|---------|-------------|
|
|
37
|
+
| `init [dir]` | Scaffold `rhost.config.json`, `.env`, and directory structure |
|
|
38
|
+
| `start` | Launch a RhostMUSH Docker container (default when no command given) |
|
|
39
|
+
|
|
40
|
+
Run `npx @rhost/server <command> --help` for full flag reference.
|
|
41
|
+
|
|
42
|
+
## Full documentation
|
|
43
|
+
|
|
44
|
+
See the [@rhost/testkit docs](https://github.com/lcanady/rhost-testkit/tree/main/docs):
|
|
45
|
+
|
|
46
|
+
- [Server CLI reference](../../docs/server-cli.md)
|
|
47
|
+
- [WebSocket & stunnel setup](../../docs/websocket.md)
|
|
48
|
+
- [Pueblo protocol](../../docs/pueblo.md)
|
package/bin.js
ADDED
package/package.json
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@rhost/server",
|
|
3
|
+
"version": "1.6.2",
|
|
4
|
+
"description": "Zero-config RhostMUSH Docker server — start, init, and configure in one command",
|
|
5
|
+
"bin": {
|
|
6
|
+
"rhost-server": "./bin.js"
|
|
7
|
+
},
|
|
8
|
+
"files": [
|
|
9
|
+
"bin.js",
|
|
10
|
+
"README.md"
|
|
11
|
+
],
|
|
12
|
+
"repository": {
|
|
13
|
+
"type": "git",
|
|
14
|
+
"url": "git+https://github.com/lcanady/rhost-testkit.git",
|
|
15
|
+
"directory": "packages/server"
|
|
16
|
+
},
|
|
17
|
+
"bugs": {
|
|
18
|
+
"url": "https://github.com/lcanady/rhost-testkit/issues"
|
|
19
|
+
},
|
|
20
|
+
"homepage": "https://github.com/lcanady/rhost-testkit/tree/main/packages/server#readme",
|
|
21
|
+
"keywords": [
|
|
22
|
+
"mush",
|
|
23
|
+
"rhostmush",
|
|
24
|
+
"rhost",
|
|
25
|
+
"server",
|
|
26
|
+
"docker",
|
|
27
|
+
"mud"
|
|
28
|
+
],
|
|
29
|
+
"license": "MIT",
|
|
30
|
+
"dependencies": {
|
|
31
|
+
"@rhost/testkit": "^1.6.2"
|
|
32
|
+
},
|
|
33
|
+
"engines": {
|
|
34
|
+
"node": ">=18"
|
|
35
|
+
}
|
|
36
|
+
}
|