Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion QUICKSTART.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ docker compose version # V2 syntax (not docker-compose)

**Missing something?** → [docs/INSTALL-FRAMEWORKS.md](docs/INSTALL-FRAMEWORKS.md) — installs Node, npm, and Docker in minutes on Mac, Linux, or Windows.

**Running on Windows?** → [docs/INSTALL-WINDOWS.md](docs/INSTALL-WINDOWS.md) — full WSL2 + Docker Desktop path for self-hosting the hub locally.

> **Why these?** Node + npm power the `annie` CLI you'll install on employee machines. Docker runs the server without you needing to install Rust, Postgres, or nginx yourself.

---
Expand Down Expand Up @@ -259,4 +261,4 @@ You now have:

*Public distribution: [contextzero/nest_hub](https://github.com/contextzero/nest_hub) · CLI: [@contextzero/nest](https://www.npmjs.com/package/@contextzero/nest).*

</div>
</div>
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ annie claude # or: annie cursor / annie codex / annie gemini ...

- 📦 [What's shipped — changelog](https://github.com/contextzero/nest_hub/issues/17)
- 📚 [Quick Start](QUICKSTART.md)
- 🪟 [Windows install guide (WSL2 + Docker Desktop)](docs/INSTALL-WINDOWS.md)
- 🛠 [Installation reference](docs/INSTALL.md)
- 🌐 [Production deploy (HTTPS)](docs/DEVOPS.md)
- 🔐 [Security model](docs/SECURITY-MODEL.md)
Expand Down
102 changes: 102 additions & 0 deletions docs/INSTALL-WINDOWS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
<div align="center">

<img src="../public/nest_logo.png" alt="NEST" width="200"/>

</div>

# NEST on Windows (WSL2 + Docker Desktop)

This guide documents the shortest supported Windows path for self-hosting NEST:
run the stack inside **WSL2**, use **Docker Desktop** as the container runtime,
and open the PWA at `http://localhost`.

## What You Need

- Windows 11, or Windows 10 with WSL2 support
- Docker Desktop for Windows
- A WSL2 Linux distro such as Ubuntu
- Git inside WSL2

## 1. Enable WSL2

In an elevated PowerShell window:

```powershell
wsl --install
```

If WSL is already installed, confirm the version:

```powershell
wsl -l -v
```

Make sure your Linux distro shows **Version 2**.

## 2. Install Docker Desktop

1. Download and install [Docker Desktop for Windows](https://docs.docker.com/desktop/install/windows-install/).
2. In Docker Desktop, enable **Use the WSL 2 based engine**.
3. In **Settings → Resources → WSL Integration**, enable integration for the distro you will use for NEST.

Verify from your WSL shell:

```bash
docker --version
docker compose version
```

## 3. Clone the Repository in WSL2

Open your WSL terminal and clone NEST into the Linux filesystem:

```bash
git clone https://github.com/contextzero/nest_hub.git
cd nest_hub
```

Using the WSL filesystem is recommended for better bind-mount and file-watch behavior than `/mnt/c/...`.

## 4. Run the Setup Script

From the repo root:

```bash
./setup.sh
```

`setup.sh` creates `.env`, pulls the published images, starts the stack, and
waits for health checks.

When setup finishes, open:

```text
http://localhost
```

If you changed `WEB_PORT` in `.env`, use that port instead.

## 5. Day-2 Commands

Run these from the repo root in WSL2:

```bash
docker compose up -d
docker compose down
docker compose logs -f
docker compose pull && docker compose up -d
```

## Troubleshooting

- If `docker` is missing in WSL2, re-check Docker Desktop WSL integration for your distro.
- If `./setup.sh` is not executable, run `chmod +x setup.sh`.
- If `http://localhost` does not load, inspect `docker compose ps` and `docker compose logs -f`.
- If another service already uses port 80, set `WEB_PORT=8080` in `.env`, then run `docker compose up -d`.

## Related Docs

- [Quick Start](../QUICKSTART.md)
- [Install frameworks and tools](INSTALL-FRAMEWORKS.md)
- [Installation reference](INSTALL.md)
- [Production deploy (HTTPS)](DEVOPS.md)