Add CLAUDE.md with project info and deployment instructions
This commit is contained in:
parent
31b1d66942
commit
c4a0819364
36
CLAUDE.md
Normal file
36
CLAUDE.md
Normal file
@ -0,0 +1,36 @@
|
|||||||
|
# mcMQTT
|
||||||
|
|
||||||
|
MCP server for MQTT broker interaction and IoT messaging. Allows LLMs to publish, subscribe, and manage MQTT topics.
|
||||||
|
|
||||||
|
- **Docs**: https://mcmqtt.warehack.ing
|
||||||
|
- **Git**: `git@git.supported.systems:MCP/mcmqtt.git`
|
||||||
|
- **Server**: `ssh -A warehack-ing@warehack.ing`, repo at `~/mcmqtt`
|
||||||
|
|
||||||
|
## Docs Site Deployment
|
||||||
|
|
||||||
|
Starlight documentation site in `docs-site/` subdirectory.
|
||||||
|
|
||||||
|
### Environment
|
||||||
|
|
||||||
|
Copy `.env.example` to `.env` in `docs-site/`:
|
||||||
|
|
||||||
|
```env
|
||||||
|
COMPOSE_PROJECT_NAME=mcmqtt-docs
|
||||||
|
DOMAIN=mcmqtt.warehack.ing
|
||||||
|
```
|
||||||
|
|
||||||
|
### Commands
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# From docs-site/ directory:
|
||||||
|
make up # Build and start production container
|
||||||
|
make down # Stop container
|
||||||
|
make logs # Tail container logs
|
||||||
|
make restart # Stop + start
|
||||||
|
```
|
||||||
|
|
||||||
|
### Deploy to Production
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ssh -A warehack-ing@warehack.ing "cd ~/mcmqtt && git pull && cd docs-site && make up"
|
||||||
|
```
|
||||||
Loading…
x
Reference in New Issue
Block a user