Skip to content

Commit dd0bc5a

Browse files
fixed utils test and update readme for @simplens/onboard
1 parent 7773a83 commit dd0bc5a

2 files changed

Lines changed: 5 additions & 21 deletions

File tree

packages/onboard/README.md

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @simplens/onboard
22

3-
> CLI tool to setup SimpleNS instances on any linux/amd64 machine
3+
> CLI tool to setup SimpleNS instances on any linux/amd64 and windows machine
44
55
## Overview
66

@@ -130,19 +130,6 @@ After successful setup, access these URLs:
130130
- **Kafka UI**: http://localhost:8080 (if Kafka selected)
131131
- **Grafana**: http://localhost:3001 (if Grafana selected)
132132

133-
## OS-Specific Notes
134-
135-
### Linux
136-
137-
On Linux, `host.docker.internal` doesn't work by default. The tool will:
138-
- Detect Linux OS
139-
- Prompt for machine IP or suggest Docker bridge IP (`172.17.0.1`)
140-
- Configure infrastructure services with the correct host
141-
142-
### Windows/macOS
143-
144-
Uses `host.docker.internal` automatically for seamless Docker networking.
145-
146133
## Examples
147134

148135
### Minimal Setup
@@ -188,13 +175,6 @@ Please start Docker Desktop or Docker daemon.
188175

189176
**Solution**: Start Docker Desktop (Windows/Mac) or `sudo systemctl start docker` (Linux)
190177

191-
### Linux Host Configuration
192-
193-
If you see connection errors on Linux, ensure:
194-
- Correct machine IP is provided during setup
195-
- Firewall allows Docker bridge network
196-
- Use `172.17.0.1` as fallback for local-only setup
197-
198178
### Plugin Installation Failed
199179

200180
```

packages/onboard/src/utils.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,5 +97,9 @@ export async function readFile(filePath: string): Promise<string> {
9797
* Append content to file
9898
*/
9999
export async function appendFile(filePath: string, content: string): Promise<void> {
100+
// Ensure parent directory exists, similar to writeFile
101+
const dir = path.dirname(filePath);
102+
await fs.mkdir(dir, { recursive: true });
103+
100104
await fs.appendFile(filePath, content, 'utf-8');
101105
}

0 commit comments

Comments
 (0)