Skip to content
Jina Connect

Quickstart

Prerequisites

Section titled “Prerequisites”
  • Docker and Docker Compose v2+
  • Git
Section titled “Docker Compose (Recommended)”

  1. Clone the repository

    Terminal window
    git clone https://github.com/JINA-CODE-SYSTEMS/jina-connect-unified-cpaas.git
    cd jina-connect-unified-cpaas

  2. Create your .env file

    Terminal window
    cp .env.example .env

    At minimum, set these values:

    SECRET_KEY=your-random-secret-key-here
    FIELD_ENCRYPTION_KEY=your-fernet-key-here
    DEBUG=True

    Generate a Fernet key for FIELD_ENCRYPTION_KEY:

    Terminal window
    python3 -c "from cryptography.fernet import Fernet; print(Fernet.generate_key().decode())"

  3. Start all services

    Terminal window
    docker compose up -d

    This starts:

    ServicePortDescription
    web8000Daphne ASGI server
    db5432PostgreSQL 15
    redis6379Redis 7 (broker + channels)
    celery—Background task worker
    celery-beat—Periodic task scheduler

  4. Run migrations (auto-runs on container start, or manually)

    Terminal window
    docker compose exec web python manage.py migrate

  5. Create a superuser

    Terminal window
    docker compose exec web python manage.py createsuperuser

  6. Access the platform

    URLDescription
    http://localhost:8000/admin/Django Admin
    http://localhost:8000/swagger/Swagger API Docs
    http://localhost:8000/redoc/ReDoc API Docs
    http://localhost:8000/version/Version info

Local Development (Without Docker)

Section titled “Local Development (Without Docker)”

  1. Clone and set up Python

    Terminal window
    git clone https://github.com/JINA-CODE-SYSTEMS/jina-connect-unified-cpaas.git
    cd jina-connect-unified-cpaas
    python3.12 -m venv venv
    source venv/bin/activate
    pip install -r requirements.txt

  2. Install system dependencies

    Terminal window
    brew install postgresql@15 redis
    brew services start postgresql@15
    brew services start redis

  3. Create database

    Terminal window
    createdb jc6

  4. Configure environment

    Terminal window
    cp .env.example .env
    # Edit .env — set SECRET_KEY, FIELD_ENCRYPTION_KEY, DB_* values

  5. Run migrations and start

    Terminal window
    python manage.py migrate
    python manage.py createsuperuser
    python manage.py runserver

  6. Start Celery worker (separate terminal)

    Terminal window
    celery -A jina_connect worker -l info

  7. Start Celery Beat (separate terminal)

    Terminal window
    celery -A jina_connect beat -l info

First Steps After Setup

Section titled “First Steps After Setup”

1. Create a Tenant

Section titled “1. Create a Tenant”

Go to http://localhost:8000/admin/ and create a Tenant with a name and industry.

2. Get an API Key

Section titled “2. Get an API Key”

Create a TenantAccessKey in the admin panel. This key is used for API auth and MCP tool access.

3. Get a JWT Token

Section titled “3. Get a JWT Token”
Terminal window
curl -X POST http://localhost:8000/token/ \
  -H "Content-Type: application/json" \
  -d '{"email": "admin@example.com", "password": "your-password"}'

4. Explore the API

Section titled “4. Explore the API”

Open http://localhost:8000/swagger/ to see all available endpoints, or head to the API Reference.

What’s Next?

Section titled “What’s Next?”