91 lines
2.9 KiB
Markdown
91 lines
2.9 KiB
Markdown
# Quickstart -- Local Dev Environment in Minutes
|
|
|
|
Get Stella Ops running locally for development and evaluation.
|
|
|
|
> This guide is for **local development**. For production deployment, see the [Installation Guide](INSTALL_GUIDE.md).
|
|
|
|
## Prerequisites
|
|
|
|
| Requirement | Minimum | Verify |
|
|
|-------------|---------|--------|
|
|
| OS | Windows 10+, macOS 12+, Ubuntu 22.04+ | x86-64 or arm64 |
|
|
| Docker | Engine 20.10+ with Compose v2 | `docker compose version` |
|
|
| .NET SDK | 10.x | `dotnet --version` |
|
|
| Node.js | 20+ | `node --version` |
|
|
| RAM | 16 GB (32 GB recommended) | |
|
|
| Disk | 50 GB free | |
|
|
|
|
## 1. Clone the repository
|
|
|
|
```bash
|
|
git clone <your-gitea-instance>/stella-ops/stella-ops.git
|
|
cd stella-ops
|
|
```
|
|
|
|
## 2. Run the setup script
|
|
|
|
**Windows (PowerShell 7):**
|
|
|
|
```powershell
|
|
.\scripts\setup.ps1
|
|
```
|
|
|
|
**Linux / macOS:**
|
|
|
|
```bash
|
|
./scripts/setup.sh
|
|
```
|
|
|
|
The script will:
|
|
- Verify all prerequisites are installed
|
|
- Offer to add hosts file entries (50 services need unique loopback IPs)
|
|
- Create `.env` from the example template (works out of the box, no editing needed)
|
|
- Start infrastructure (PostgreSQL, Valkey, RustFS)
|
|
- Build .NET solutions and Docker images
|
|
- Launch the full platform
|
|
- Run health checks and report status
|
|
|
|
### Infrastructure only (faster)
|
|
|
|
To skip builds and just start infrastructure:
|
|
|
|
```powershell
|
|
.\scripts\setup.ps1 -InfraOnly # Windows
|
|
./scripts/setup.sh --infra-only # Linux/macOS
|
|
```
|
|
|
|
## 3. Open the platform
|
|
|
|
Once setup completes, open **https://stella-ops.local** in your browser.
|
|
|
|
Accept the self-signed certificate warning on first visit.
|
|
|
|
## What's running
|
|
|
|
After a full setup, you'll have 45+ services running locally:
|
|
|
|
| Service | URL | Purpose |
|
|
|---------|-----|---------|
|
|
| Web UI | https://stella-ops.local | Angular console |
|
|
| Authority | https://authority.stella-ops.local | OAuth2/OIDC |
|
|
| Scanner | https://scanner.stella-ops.local | SBOM/vulnerability scanning |
|
|
| Concelier | https://concelier.stella-ops.local | Advisory aggregation |
|
|
| PostgreSQL | db.stella-ops.local:5432 | Primary database |
|
|
| Valkey | cache.stella-ops.local:6379 | Cache and messaging |
|
|
|
|
Full service list: `devops/compose/docker-compose.stella-ops.yml`
|
|
|
|
## Troubleshooting
|
|
|
|
**"stella-ops.local not found"** -- The hosts file entries are missing. Re-run the setup script and accept the hosts file installation, or manually append `devops/compose/hosts.stellaops.local` to your hosts file.
|
|
|
|
**Containers unhealthy** -- Check logs with `docker compose -f devops/compose/docker-compose.stella-ops.yml logs <service-name>`.
|
|
|
|
**Port conflicts** -- Override ports in `devops/compose/.env`. See `devops/compose/env/stellaops.env.example` for available port variables.
|
|
|
|
## Next steps
|
|
|
|
- [Developer setup details](dev/DEV_ENVIRONMENT_SETUP.md) -- manual steps, hybrid debugging, building individual modules
|
|
- [Installation Guide](INSTALL_GUIDE.md) -- production deployment, air-gap, regional compliance
|
|
- [Architecture overview](ARCHITECTURE_OVERVIEW.md) -- how the platform fits together
|