Skip to main content

Installation

HridaSign ships as a single Docker image — a Spring Boot process that serves the REST API and the built React frontend.

Prerequisites​

  • Docker and Docker Compose
  • A PostgreSQL instance. The bundled compose file targets an existing hrida-postgres container on an external hridaai-network (shared with other Hrida apps, separate database); point SPRING_DATASOURCE_URL at your own if you prefer.

Deploy​

cp .env.example .env      # fill in the values
docker compose up -d --build

The container binds 127.0.0.1:8084 → 8080 internally. Put a TLS-terminating reverse proxy in front. Uploads persist in the uploads_data volume.

Required values​

VariableNotes
DB_NAME / DB_USERNAME / DB_PASSWORDThe database. POSTGRES_HOST names the server.
JWT_SECRETSigns session tokens — a long random string, never reused across environments.
APP_URLPublic origin, used for email deep-links (invitations, OTP). https://sign.hrida.ai in production.
CORS_ALLOWED_ORIGINSComma-separated browser origin allow-list.
MAIL_HOST / MAIL_PORT / MAIL_USERNAME / MAIL_PASSWORD / MAIL_FROMSMTP for signing invitations and OTP. Gmail needs an App Password.
ADMIN_SETUP_KEYGuards platform-admin bootstrap (POST /api/admin/auth/register).

Optional integrations​

Leave empty to disable:

FeatureVariables
Cloudinary storageCLOUDINARY_CLOUD_NAME, CLOUDINARY_API_KEY, CLOUDINARY_API_SECRET
OpenAI (AI PDF tools)OPENAI_API_KEY, OPENAI_OCR_MODEL
Razorpay paymentsRAZORPAY_KEY_ID, RAZORPAY_KEY_SECRET, RAZORPAY_WEBHOOK_SECRET
Contact routingCONTACT_TEAM_EMAIL

Full reference in Configuration.

Local development​

Per the project's own work-details/ notes, dev runs the two processes separately:

PortProcess
5173Vite dev server (frontend)
8080Spring Boot API
5432PostgreSQL
# backend
cd backend && ./mvnw spring-boot:run
# frontend
cd frontend && npm install && npm run dev

First run​

  1. Bootstrap the first platform owner with ADMIN_SETUP_KEY via POST /api/admin/auth/register.
  2. Seed the plan catalog (or let the app seed defaults).
  3. Users self-register at /register; a company registers at /register-company, which creates the organization and its first org admin.
Hrida.ai is proprietary software of Zlabs Innovation. See the license for terms. © 2026 Zlabs Innovation.