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
27 changes: 21 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ ushadow/
├── scripts/ # Utility scripts
├── tests/ # Test suites
├── docker-compose.yml # Main application compose
├── quickstart.sh # Quick start script
├── go.sh # Quick start script (./dev.sh for development)
└── README.md
```

Expand Down Expand Up @@ -404,22 +404,37 @@ make test
### Start All Services

```bash
./quickstart.sh
./go.sh
```

Or manually:

```bash
# Start infrastructure
docker compose -f deployment/docker-compose.infra.yml up -d
docker compose -f compose/docker-compose.infra.yml up -d

# Start Chronicle
docker compose -f deployment/docker-compose.chronicle.yml up -d
docker compose -f compose/chronicle-compose.yaml up -d

# Start ushadow
docker compose up -d
```

### Start infrastructure only: `make infra-up`

Starts MongoDB, Redis, and Qdrant (and memory services). Use it when:

- You want to run the ushadow app separately (e.g. `make up` or `./dev.sh` after infra is up)
- Infrastructure was stopped (`make infra-down`) and you need it again
- You're running frontend/backend manually and only need the databases

**Summary:** Use `./go.sh` or `./dev.sh` for a full start (they bring up infra too). Use `make infra-up` when you only want infra or when you start the app in a separate step.

```bash
make infra-up # Start infrastructure
make infra-down # Stop infrastructure
```

### Stop Services

```bash
Expand All @@ -428,8 +443,8 @@ docker compose down

# Stop everything
docker compose down
docker compose -f deployment/docker-compose.chronicle.yml down
docker compose -f deployment/docker-compose.infra.yml down
docker compose -f compose/chronicle-compose.yaml down
docker compose -f compose/docker-compose.infra.yml down
```

### View Logs
Expand Down
6 changes: 4 additions & 2 deletions clear.sh
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ echo "⚠️ WARNING: This will:"
echo " - Remove ALL admin users from the database"
echo " - Delete config/SECRETS/secrets.yaml (all API keys and credentials)"
echo " - Delete config/config.overrides.yaml (wizard state and service preferences)"
echo " - Allow you to run ./quick-start.sh for a fresh setup"
echo " - Allow you to run ./dev.sh or ./go.sh for a fresh setup"
echo ""
read -p "Are you sure? (yes/no): " -r
echo ""
Expand Down Expand Up @@ -89,7 +89,9 @@ echo "✅ Admin reset complete!"
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
echo ""
echo "🚀 Next steps:"
echo " 1. Run ./start-dev.sh to regenerate secrets and setup"
echo " 1. Regenerate secrets and start:"
echo " • ./dev.sh - development (hot-reload for frontend/backend)"
echo " • ./go.sh - quick start (production build, opens browser)"
echo " 2. Clear your browser cache (Cmd+Shift+R or hard refresh)"
echo " 3. Log in with your new admin credentials"
echo ""
Expand Down
6 changes: 3 additions & 3 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@
#
# Recommended workflow:
# ./go.sh # First time (handles everything)
#. ./quick-start.sh # Setup infra + app and options
# make up # Daily use (auto-starts infra if needed)
# ./dev.sh # Development (hot-reload)
# make up # Daily use (auto-starts infra if needed)
#
# Direct docker compose (manual):
# docker compose -f docker-compose.infra.yml up -d # Start infra first
# docker compose up -d # Then start app
# docker compose down # Stop app only
#
# Environment:
# Uses .env.default (auto-generated by ./quick-start.sh)
# Uses .env (auto-generated by ./go.sh or ./dev.sh)

name: ushadow

Expand Down
2 changes: 1 addition & 1 deletion setup/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ $ python3 setup/setuputils.py get-redis-marker 2
### Integration

Used by:
- `quick-start.sh` - Interactive environment setup
- `go.sh` / `dev.sh` - Environment setup and startup
- Multi-worktree configurations - Port and database isolation
- CI/CD pipelines - Environment validation

Expand Down