Skip to content

Commit e02a4f2

Browse files
committed
docs: add troubleshooting section to README tunnel startup failures, health check problems
Include solutions for port conflicts and TypeScript import errors Add guidance on getting help via GitHub issues, API reference, and examples
1 parent 6032c26 commit e02a4f2

1 file changed

Lines changed: 38 additions & 0 deletions

File tree

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,44 @@ bun run lint
119119

120120
All changes are documented in the [CHANGELOG.md](./CHANGELOG.md) file.
121121

122+
## Troubleshooting
123+
124+
### Common Issues
125+
126+
1. **Tunnel fails to start**
127+
- Check if the port is already in use
128+
- Verify your ngrok authtoken if using premium features
129+
- Ensure you have necessary permissions to execute the tunnel binary
130+
131+
2. **Health check failures**
132+
- Verify your network connection
133+
- Check if your local server is responding
134+
- Adjust health check timeout if network latency is high
135+
136+
3. **"Port already in use" errors**
137+
```typescript
138+
// Make sure to stop existing tunnels before starting new ones
139+
await existingWebhook.stop();
140+
await new AutoWebhook().start();
141+
```
142+
143+
4. **TypeScript import issues**
144+
```typescript
145+
// If you see type errors, make sure your tsconfig.json includes:
146+
{
147+
"compilerOptions": {
148+
"moduleResolution": "bundler",
149+
"esModuleInterop": true
150+
}
151+
}
152+
```
153+
154+
### Getting Help
155+
156+
- Open an issue on [GitHub](https://github.com/rozeraf/autowebhook/issues)
157+
- Check the [API Reference](./API.md) for detailed documentation
158+
- Review the [Examples](./EXAMPLES.md) for common usage patterns
159+
122160
## License
123161

124162
This project is distributed under the GPL-3.0-only license. See the [LICENSE](./LICENSE) file for more information.

0 commit comments

Comments
 (0)