Kyndex
/Docs
Request a Demo
Deployment

Admin Setup

Configure a deployment after its administrator account and external services are ready.

1

Set up administrator access

Sign in with an account that has administrator permissions. For local development,ADMIN_EMAILS works only when ALLOW_ADMIN_EMAIL_BYPASS=true. For production with Supabase, set app_metadata: { "role": "admin" } on the user.

Provision administrator identities through your configured identity provider.

2

Create your organization

Open /dashboard/admin, choose the Organization tab, and click Create Organization.

Set a name and slug. The organization is used to scope platform data.

3

Create departments

Go to /dashboard/departments → New Department.

Departments can scope document access, memberships, and budgets. Create them to match how you plan to organize access.

Example structure: Engineering · Finance · HR · Sales

4

Add team members

Administrators provision or invite users through the deployment's identity provider. The console has no public registration form or API endpoint.

Google/GitHub sign-in remains available when configured. Provider settings determine whether a first social sign-in creates an identity; removing the form does not enforce closed admission. Staging uses provisioned demo users. Verify provider signup restrictions before treating it as closed access.

Add an existing user from /dashboard/departments → select department → Members. The form asks for the user ID and department role.

Roles: dept_admin can manage dept docs and members. dept_member can query. dept_viewer read-only.

5

Set token budgets

Go to /dashboard/usage → Budgets tab → New Budget.

Create user, department, or organization budgets with a daily or monthly token limit. Available limit actions include blocking, warning, or selecting a downgrade model.

6

Configure connectors (optional)

Open /dashboard/connectors and select a connector type.

Available connectors include GitHub, Slack, Jira, Confluence, Notion, Google Drive, and a text webhook. Each connector supports specific source content and credentials.

Enter connector credentials in the console. They are stored by the application; configure the field encryption key and restrict access to the deployment.

Use the connector's sync action to request a sync. The worker processes queued work; source APIs and credentials must be reachable from the deployment.

7

Upload your first document

Go to /dashboard/documents → Upload.

Supported extensions include PDF, DOCX, DOC, TXT, MD, RST, and CSV. Set scope: personal (only you), department (your dept), or global (all org members).

Processing is asynchronous. Status and completion time depend on document size and the configured parser and embedding services.

8

Run your first query

Go to /dashboard/query and ask a question about indexed content. Relevant answers include citations when source material is retrieved.

If you get no results, check that your document processed successfully (status = ready in the Documents page).

Troubleshooting

  • Query returns no results: check document status, access scope, and retrieved content.
  • 429 response: inspect the API response and rate-limit or budget configuration.
  • Worker not processing: check Redis connectivity and worker logs.
  • Connector sync fails: check the saved credentials and access to the source API.