@@ -4,6 +4,8 @@ This repository contains a working self-hosted setup of Happy (server + CLI) wit
44
55## QUICKSTART: Self Hosting
66
7+ ### Step 0: Build and Launch Services
8+
79Run your own Happy instance with two containers - one for the webapp and one for the server:
810
911``` bash
@@ -17,12 +19,58 @@ make server
1719make web
1820```
1921
20- Then open http://localhost:8081 in your browser.
21-
2222** Other container options:**
2323- ` make root ` - Interactive shell with no ports forwarded
2424- ` make root-all-ports ` - Interactive shell with both ports (8081 + 3005) forwarded
2525
26+ ### Step 1: Create an Account
27+
28+ 1 . Open http://localhost:8081 in your browser
29+ 2 . Click "Create Account"
30+ 3 . Optionally add a recognizable username in Account settings
31+
32+ ### Step 2: View Your Secret Key
33+
34+ 1 . Go to Account settings in the webapp
35+ 2 . Find and copy your secret backup key (format: ` XXXXX-XXXXX-... ` )
36+
37+ ### Step 3: Install the CLI on Development Machines
38+
39+ On each machine where you want to run Claude with Happy:
40+
41+ ``` bash
42+ # Clone and install the fork
43+ git clone --depth=1 https://github.com/rrnewton/happy-cli.git /usr/local/happy
44+ cd /usr/local/happy
45+ npm install
46+ npm run build
47+ npm install -g .
48+ ```
49+
50+ ### Step 4: Authenticate the CLI
51+
52+ Use the secret key from Step 2 to authenticate:
53+
54+ ``` bash
55+ happy auth login --backup-key < YOUR-SECRET-KEY>
56+ ```
57+
58+ ### Step 5: Start the Daemon
59+
60+ ``` bash
61+ happy daemon start
62+ ```
63+
64+ The daemon connects your machine to the Happy server, allowing remote control from the webapp.
65+
66+ ### Step 6: (Optional) Voice Assistant Setup
67+
68+ For ElevenLabs voice assistant integration:
69+ 1 . Go to Account > Voice Assistant in the webapp
70+ 2 . Click "Get API Key" to create an ElevenLabs API key with required permissions
71+ 3 . Enter your API key and save credentials
72+ 4 . Use "Find Agent" or "Create/Update Agent" to set up the voice agent
73+
2674## Getting Started
2775
2876### Build and Run Container
@@ -117,10 +165,10 @@ See [WEB_CLIENT_GUIDE.md](WEB_CLIENT_GUIDE.md) for detailed instructions.
117165### Start Services
118166
119167``` bash
120- ./happy-demo .sh start # Start all services
121- ./happy-demo .sh status # Check what's running
122- ./happy-demo .sh stop # Stop services
123- ./happy-demo .sh cleanup # Stop everything including databases
168+ ./happy-launcher .sh start # Start all services
169+ ./happy-launcher .sh status # Check what's running
170+ ./happy-launcher .sh stop # Stop services
171+ ./happy-launcher .sh cleanup # Stop everything including databases
124172```
125173
126174### Setup Test Credentials
@@ -176,10 +224,12 @@ export HAPPY_SERVER_URL=http://localhost:3005
176224
177225## Key Scripts
178226
179- ### happy-demo .sh
227+ ### happy-launcher .sh
180228Main control script for managing services:
181- - ` start ` - Start all services
182- - ` stop ` - Stop happy-server and MinIO
229+ - ` start ` - Start all services (backend + webapp)
230+ - ` start-backend ` - Start only backend services
231+ - ` start-webapp ` - Start only the webapp
232+ - ` stop ` - Stop happy-server, webapp, and MinIO
183233- ` cleanup ` - Stop everything including databases
184234- ` status ` - Show service status
185235- ` logs <service> ` - View logs
@@ -213,14 +263,14 @@ All ports are automatically forwarded when using the devcontainer.
213263
214264### Server not responding
215265``` bash
216- ./happy-demo .sh status # Check all services
217- ./happy-demo .sh logs server # View server logs
266+ ./happy-launcher .sh status # Check all services
267+ ./happy-launcher .sh logs server # View server logs
218268```
219269
220270### Clean slate
221271``` bash
222- ./happy-demo .sh cleanup --clean-logs # Stop everything and clean logs
223- ./happy-demo .sh start # Fresh start
272+ ./happy-launcher .sh cleanup --clean-logs # Stop everything and clean logs
273+ ./happy-launcher .sh start # Fresh start
224274```
225275
226276### Database issues
0 commit comments