Skip to content

Admin Setup & First Boot

Once BoxedAI is running, you need to create the first administrative user (superuser) to configure the system.

1. Retrieve the Setup Code

For security, the initial setup page is protected by a one-time code generated on the server console. This prevents unauthorized users from taking over a fresh installation.

To find the code, check the logs of the backend container:

bash
docker compose logs backend | grep "Admin Setup Code"

You should see a message like:

[ADMIN] Admin Setup Code: 1234-5678-ABCD-EFGH

2. Create the Superuser

  1. Navigate to http://localhost/setup in your browser.
  2. Enter the Setup Code you retrieved from the logs.
  3. Fill in the Superuser Details:
    • Email: Your admin email address.
    • Password: A strong password for your account.
    • Organization Name: The name of your primary organization (e.g., "My Company").
  4. Click Complete Setup.

You will be automatically logged in as the Superuser.

3. System Configuration

After logging in, navigate to the Admin Dashboard (usually found in the sidebar or user menu). Here you should configure the AI inference settings:

  1. Go to Settings -> Inference.
  2. Provider: Select OpenAI or OpenRouter.
  3. Model Name: Enter the model ID (e.g., gpt-4o, gpt-3.5-turbo).
  4. API Key: Enter your provider's API key. Note: API keys are encrypted at rest.
  5. Click Save.

4. Managing Capabilities

Capabilities are AI tools that extend what the assistant can do. As an admin, you control which capabilities are available to your organization.

  1. Navigate to Admin -> Capabilities.
  2. You'll see a list of all available capabilities with toggle switches.
  3. Toggle capabilities on or off for your organization.
CapabilityDefaultDescription
CalculatorOnSafe math expression evaluation
File SearchOnSemantic search across uploaded documents
File ReadOnRead content of specific uploaded files

When a capability is disabled, the AI simply won't have access to that tool — it won't appear in the tool list sent to the LLM.

5. Managing Analyzers

Analyzers extract text from uploaded files, enabling full-text search and file content retrieval. Like capabilities, they are toggled per organization.

  1. Navigate to Admin -> Analyzers.
  2. You'll see a list of all available analyzers with toggle switches.
  3. Toggle analyzers on or off for your organization.
AnalyzerDefaultDescription
text_plainOnExtracts text from plain text files (.txt, .md, .csv, etc.)
pdf_extractOnExtracts text from PDF documents
docx_extractOnExtracts text from Microsoft Word (.docx) files

When an analyzer is disabled, files of that type will still be stored but won't have text extracted for search.

6. User Management

As an admin, you can now:

  • Invite Users: Create accounts for your team members.
  • Manage Groups: Organize users into groups for access control.

7. System Management

The Admin -> System page provides system-level operations:

  • Reset (Nuke): Completely reset the system, removing all data. This is a destructive, irreversible operation intended for development or re-provisioning scenarios.

8. Encryption (Optional)

You can enable zero-knowledge encryption for your organization. See Encryption for details.