Getting Started with Sentinel
From a fresh clone to a running, AI‑powered DevOps dashboard with auto‑healing and CLI tools.
Prerequisites
Before you start, install Docker, Node.js 18+, Git, and create a Groq API key.
- Docker & Docker Compose – installation guide
- Node.js 18+ – downloads
- Git – installers
- Groq API key – Groq console
PostgreSQL, Kestra, and mock services are launched automatically via docker-compose.yml; no separate install is needed.
Clone the Repository
Clone the Sentinel repo and move into the project folder.
git clone https://github.com/SKfaizan-786/sentinel-devops-agent.git
cd sentinel-devops-agentConfigure Environment Variables
Backend (.env)
Copy the example env file and edit required values.
cp backend/.env.example backend/.envAt minimum, set GROQ_API_KEY, check the Postgres credentials, and change JWT_SECRET for anything beyond local testing.
Frontend (.env.local)
cd sentinel-frontend
cp .env.example .env.local
# set NEXT_PUBLIC_BACKEND_URL to http://localhost:4000
cd ..Start the Full Stack with Docker
Bring up backend, frontend, Kestra and dependencies in one step.
docker-compose up -dVerify containers are running:
docker psYou should see containers for the backend, frontend, Kestra, Postgres, and the mock services for auth, payment, and notification.
Initialize Backend & RBAC
Install backend dependencies and run the quick setup script.
cd backend
npm install
npm run quick-setupThis seeds a default admin user for local development:admin@example.com / password123 – change this after logging in.
Run Frontend via npm (Optional)
If you prefer a Next.js dev server instead of the Dockerized frontend:
cd sentinel-frontend
npm install
npm run devThe app will be available at http://localhost:3000. Ensure the backend is running on port 4000.
CLI Quick Start
Use the Sentinel CLI to interact with the system.
cd cli
npm install
npm link# Show overall system health
sentinel status
# Simulate failures (chaos tests)
sentinel simulate auth down
sentinel simulate payment degraded
sentinel simulate notification slow
# Trigger a manual heal action
sentinel heal auth
# Generate an AI incident report
sentinel reportCommon Issues & Troubleshooting
Ran into a problem? Start with these frequently‑seen errors and fixes.
Next Steps
Once you are comfortable with the basic setup, dive deeper into the architecture and APIs.
- ARCHITECTURE.md – high‑level system design and data flow.
- API.md – backend API reference.
- DEVELOPMENT.md – advanced dev workflows.
- DOCUMENTATION.md– documentation index.
- FAQ.md – common operational questions.