Skip to content

Conversation

@nahom-d54
Copy link
Collaborator

This pull request introduces essential setup files and documentation for running, testing, and deploying the ExploitRAG backend. The main changes include new quick start guides, Docker configuration files, environment variable templates, and a GitHub Actions workflow for backend tests. These additions streamline onboarding, local development, CI/CD, and containerization.

Documentation and Quick Start Guides:

  • Added QUICK_START.md and QUICK_START_HYBRID_AGENT.md with step-by-step instructions for running the backend, configuring services, ingesting data, using agent search, troubleshooting, and verifying setup. These guides cover both standard and hybrid/agent modes, including example API calls and feature explanations. [1] [2]

Environment and Configuration Files:

  • Added backend/.env.example and backend/.env.test to provide example environment variable configurations for development and testing, including database, Redis, ChromaDB, JWT, Gemini API, and rate limiting settings. [1] [2]

Docker Support:

  • Added backend/Dockerfile for building and running the backend in a container, including multi-stage builds for optimized image size, health checks, and non-root user setup.
  • Added backend/.dockerignore to exclude unnecessary files from Docker build context, improving build speed and reducing image size.

Testing and CI/CD:

  • Introduced .github/workflows/backend-tests.yml to automate backend tests on pushes and pull requests, including service setup (Postgres, Redis), linting, test execution, coverage reporting, and badge generation.

Git Ignore Updates:

  • Updated backend/.gitignore to exclude build artifacts, environment files, IDE/project settings, data files, logs, and other non-essential files from version control.

…nment

- Set up services for FastAPI backend, PostgreSQL, Redis, ChromaDB, and optional Next.js frontend.
- Include health checks for each service.
- Configure environment variables for database and API connections.
test(unit): add unit tests for authentication service, chunking utilities, database models, and security utilities
@gitguardian
Copy link

gitguardian bot commented Jan 23, 2026

⚠️ GitGuardian has uncovered 3 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request
GitGuardian id GitGuardian status Secret Commit Filename
26339814 Triggered Generic Password 1be3711 backend/app/schemas/auth.py View secret
26339815 Triggered Generic Password 1be3711 backend/app/schemas/user.py View secret
13009185 Triggered Generic Password 19f68f9 .github/workflows/backend-tests.yml View secret
🛠 Guidelines to remediate hardcoded secrets
  1. Understand the implications of revoking this secret by investigating where it is used in your code.
  2. Replace and store your secrets safely. Learn here the best practices.
  3. Revoke and rotate these secrets.
  4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider


🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants