Skip to content

Commit 1edb57d

Browse files
committed
Added openclaw to the PATH
Better wizard ui
1 parent 452918a commit 1edb57d

4 files changed

Lines changed: 316 additions & 214 deletions

File tree

Dockerfile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ RUN OPENCLAW_A2UI_SKIP_MISSING=1 pnpm build
3535
ENV OPENCLAW_PREFER_PNPM=1
3636
RUN pnpm ui:build
3737

38+
# Make the openclaw CLI available in PATH
39+
RUN ln -s /app/openclaw.mjs /usr/local/bin/openclaw
40+
3841
ENV NODE_ENV=production
3942

4043
# Install ttyd (web terminal) - static binary from GitHub releases

docker-compose.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
version: "3.8"
12
services:
23
gateway:
34
build:

getting-started.md

Lines changed: 27 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -1,110 +1,46 @@
1-
# Getting Started with OpenClaw on DappNode
1+
# OpenClaw
22

3-
Welcome to OpenClaw, your self-hosted AI agent gateway!
3+
Self-hosted AI gateway for DappNode
44

5-
## Quick Start
6-
7-
1. **Run the Setup Wizard**: The easiest way to get started is through the built-in wizard:
8-
```
9-
http://gateway.openclaw.public.dappnode:8080
10-
```
11-
It will walk you through choosing an AI provider, entering your API key, and optionally connecting messaging apps like Telegram or Discord.
12-
13-
2. **Access the Web UI**: Once configured, open the main interface:
14-
```
15-
http://gateway.openclaw.public.dappnode:18789
16-
```
5+
---
176

18-
3. **Set Your Gateway Token**: For security, set a gateway access token in the setup wizard or environment variables.
7+
## Quick Links
198

20-
## Features
9+
- **[Open Setup Wizard](http://gateway.openclaw.public.dappnode:8080)** — Pick your AI provider, enter your API key, and start chatting in minutes.
10+
- **[Web UI](http://gateway.openclaw.public.dappnode:18789)** — Chat with AI models in your browser.
11+
- **[Terminal](http://gateway.openclaw.public.dappnode:7681)** — Shell access inside the container.
2112

22-
### Web Interface
23-
- Chat with AI models directly in your browser
24-
- Canvas mode for visual interactions
25-
- Session management and history
13+
---
2614

27-
### Terminal Access
28-
Need to troubleshoot or run commands inside the container? OpenClaw includes a built-in web terminal:
29-
```
30-
http://gateway.openclaw.public.dappnode:7681
31-
```
32-
This opens a full Bash shell in your browser -- no SSH needed. You can use it to:
33-
- Check logs and debug issues
34-
- Inspect configuration files
35-
- Install additional tools
36-
- Run one-off commands
37-
38-
You can also access it from the **Terminal** link in your DappNode package dashboard.
15+
## Quick Start
3916

40-
### Messaging Integrations
41-
Configure bots to chat with AI through:
42-
- **Telegram**: Add your bot token from @BotFather
43-
- **Discord**: Create a bot at Discord Developer Portal
44-
- **Slack**: Configure a Slack app with bot tokens
45-
- **WhatsApp**: Use Twilio for WhatsApp integration
46-
- **Matrix**: Connect to your Matrix homeserver
17+
1. **Run the Setup Wizard** — Click the link above or visit `:8080`. Choose a provider (OpenAI, Anthropic, Ollama, etc.), enter your API key, and pick a model.
18+
2. **Open the Web UI** — Go to `:18789` and start a conversation with your AI.
19+
3. **Connect messaging apps** — Optionally add Telegram, Discord, or other bots in the wizard so you can chat from any device.
4720

48-
### API Access
49-
OpenClaw exposes an OpenAI-compatible API at:
50-
```
51-
http://gateway.openclaw.public.dappnode:18789/api
52-
```
21+
> **Using Ollama?** Install an Ollama package on your DappNode first, then the wizard will auto-detect it.
5322
54-
Use your gateway token for authentication.
23+
---
5524

56-
## Environment Variables
25+
## Supported Channels
5726

58-
All configuration is done through environment variables. Access them in DappNode's package config:
27+
Telegram · Discord · Slack · WhatsApp · Matrix · Web UI
5928

60-
| Variable | Description |
61-
|----------|-------------|
62-
| `OPENCLAW_GATEWAY_TOKEN` | Secret token for API access |
63-
| `OPENAI_API_KEY` | OpenAI API key |
64-
| `ANTHROPIC_API_KEY` | Anthropic Claude API key |
65-
| `TELEGRAM_BOT_TOKEN` | Telegram bot token |
66-
| `DISCORD_BOT_TOKEN` | Discord bot token |
29+
---
6730

68-
See the full list in the DappNode package configuration panel.
31+
## API Access
6932

70-
## Backup & Restore
33+
OpenClaw exposes an OpenAI-compatible API at `http://gateway.openclaw.public.dappnode:18789/api`. Use your gateway token for authentication.
7134

72-
Your OpenClaw data is automatically backed up by DappNode. The backup includes:
73-
- Configuration files
74-
- Conversation history
75-
- Session data
35+
---
7636

7737
## Troubleshooting
7838

79-
### Gateway not accessible
80-
- Check that the container is running in DappNode
81-
- Verify no firewall is blocking ports 18789/18790
82-
- Check container logs for errors
83-
84-
### API key errors
85-
- Verify your API key is correctly entered
86-
- Check your provider account has available credits
87-
- Ensure the API key has the required permissions
88-
89-
### Bot not responding
90-
- Verify bot tokens are correctly configured
91-
- Check that the bot has proper permissions in the chat platform
92-
- Review logs for connection errors
93-
94-
### Using the built-in terminal
95-
If you need to inspect the container directly, open the web terminal at:
96-
97-
```
98-
http://gateway.openclaw.public.dappnode:7681
99-
```
100-
101-
From there you can run commands like:
102-
- `cat /home/node/.openclaw/openclaw.json` -- View the current configuration
103-
- `ls /home/node/.openclaw/` -- List data files
104-
- `curl -sf http://localhost:18789/health` -- Test the health endpoint
105-
106-
## Support
39+
| Problem | Solution |
40+
|---|---|
41+
| **Gateway not reachable** | Check the container is running. Verify ports 18789/8080 are not blocked. |
42+
| **API key errors** | Re-enter your key in the wizard. Confirm your provider account has credits. |
43+
| **Bot not responding** | Verify bot tokens and permissions. Check logs via the terminal. |
44+
| **Debug from terminal** | Open the web terminal and run: `openclaw doctor` |
10745

108-
- [OpenClaw Documentation](https://docs.openclaw.ai)
109-
- [GitHub Issues](https://github.com/dappnode/DAppNodePackage-openclaw/issues)
110-
- [DappNode Discord](https://discord.gg/dappnode)
46+
---

0 commit comments

Comments
 (0)