@asrient/create-homecloud-creds 0.0.1 → 0.0.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.
Files changed (2) hide show
  1. package/README.md +30 -0
  2. package/package.json +1 -1
package/README.md ADDED
@@ -0,0 +1,30 @@
1
+ # @asrient/create-homecloud-creds
2
+
3
+ Interactive CLI tool to generate credentials for [HomeCloud Server](https://github.com/asrient/HomeCloud).
4
+ Run this before you setup your HomeCloud server.
5
+
6
+ ## Usage
7
+
8
+ ```bash
9
+ npx @asrient/create-homecloud-creds
10
+ ```
11
+
12
+ To setup your HomeCloud server check out https://www.npmjs.com/package/@asrient/homecloud-server
13
+
14
+ ## Output
15
+
16
+ A `creds.json` file containing the encrypted credentials. Use it to start the HomeCloud server:
17
+
18
+ ```bash
19
+ PASSPHRASE=your-passphrase CREDS_PATH=./creds.json homecloud-server
20
+ ```
21
+
22
+ Or with the base64 option (useful for Docker/cloud deployments):
23
+
24
+ ```bash
25
+ PASSPHRASE=your-passphrase CREDS_BASE64=<base64-string> homecloud-server
26
+ ```
27
+
28
+ ## Requirements
29
+
30
+ - Node.js 18+ (uses built-in `fetch`)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@asrient/create-homecloud-creds",
3
- "version": "0.0.1",
3
+ "version": "0.0.2",
4
4
  "description": "Generate credentials for HomeCloud Server",
5
5
  "bin": "index.js",
6
6
  "license": "MIT",