DeepFellow DOCS

DeepFellow Server Web Panel

Sign-in

Type the following in your terminal:

deepfellow server info

You will get the similar output to this:

$ deepfellow server info
💡      Information about DeepFellow Server:
        SERVER_PORT: 8000
        SERVER_URL: http://localhost:8000
        SERVER_IMAGE: hub.simplito.com/deepfellow/deepfellow-server:v0.14.0
        INFRA_DOCKER_SUBNET: deepfellow-infra-net
        METRICS_USERNAME: deepfellow-metrics
        METRICS_PASSWORD: *****
        LOG_LEVEL: INFO
        PLUGINS_SETUP: {}
        MONGO_URL: mongo:27017
        MONGO_USER: deepfellow-user
        MONGO_PASSWORD: *****
        MONGO_DB: deepfellow
        MONGO_INITDB_ROOT_USERNAME: root
        MONGO_INITDB_ROOT_PASSWORD: example-root-password
        MONGO_PORT: 27017
        INFRA__URL: http://infra:8086
        INFRA__API_KEY: *****
        VECTOR_DATABASE__PROVIDER__ACTIVE: 1
        VECTOR_DATABASE__PROVIDER__TYPE: milvus
        VECTOR_DATABASE__PROVIDER__URL: http://milvus:19530
        VECTOR_DATABASE__PROVIDER__USER: deepfellow-user
        VECTOR_DATABASE__PROVIDER__PASSWORD: *****
        VECTOR_DATABASE__EMBEDDING__ACTIVE: 1
        VECTOR_DATABASE__EMBEDDING__ENDPOINT: http://infra:8086
        VECTOR_DATABASE__EMBEDDING__MODEL: text-embedding-3-small
        VECTOR_DATABASE__EMBEDDING__SIZE: 1536

Head to http://localhost:8000 to access the Web Panel's sign-in screen:

DeepFellow Server Web Panel sign-in screen with email and password inputs

Enter the administrator credentials you have set during Installation to access the Administrator view:

DeepFellow Server Web Panel with example user data

Organizations and Projects

Organization is the main unit in DeepFellow Server. Each organization can contain multiple projects, which are another level of the server's hierarchy. Each organization can be managed by the Server's Administration Web API using Organization API Keys. Organizations can have multiple Organization API Keys.

Operations inside a specific project are done using API Keys. Each project can have multiple API Keys.

Managing Organizations

Go to the organizations view using the sidebar menu:

organizations page in DeepFellow Web Panel with list of user's organizations

Creating an Organization

In the organizations menu, click the "Create Organization" button. Enter the name and click "Create" – your new organization will be added to the list.

You can also create organizations programmatically.

Organization Details

Click the "View Details" button on the organizations list, to see the list of projects under the chosen organization.

Go to Managing Projects to read about managing your projects.

Go to Organization API Keys to read about managing Organization API Keys.

page with details about an example organization, including its name, ID, status, and date created

Organization API Keys

To manage Organization API Keys, go to "Organization API Keys" tab from inside an organization's page. Here, you can create or delete Organization API Keys.

To create one, click "Create API Key". In the pop-up, enter a name for the key and click "Create". The next pop-up will show the key value – copy and save it, you can't access it again.

To delete an API Key, click the trashcan icon and confirm by clicking "Delete". This action is irreversible.

You can also create Organization API Keys programmatically.

pop-up window with a generated example API Key

Organization Users

Open the "USERS" tab from inside an organization's page to see every user that belongs to the organization. The tab has two buttons: "Invite" and "Invitation history".

Inviting users requires a configured SMTP server. See Configure Email for Invitations to set it up.

Inviting Users

Only an organization admin or owner will send invitations.

Click "Invite", enter the email address of the person you want to add, and confirm. DeepFellow Server creates an invitation and emails a link to that address.

What the invited person receives depends on whether the email already belongs to a DeepFellow account:

  • If the email belongs to an existing account, the email contains an invitation link. See Accepting an Invitation.
  • If the email has no account yet, the email contains a registration link. See Registering Through an Invitation. Whether an admin or the organization owner is allowed to invite a person without an account is controlled by the DF_ONLY_ADMIN_CAN_CREATE_ACCOUNTS_BY_INVITATION variable, described in Configure Email for Invitations.

You can also create invitations programmatically.

Invitation History

Click "Invitation history" to review the invitations sent for the organization. For each invitation the list shows:

  • the invited email address
  • who sent the invitation
  • whether the invitation was used
  • whether the invitation has expired

Managing Projects

Creating Projects

To create a project, go to the projects tab in organizations view, click the "Create project" button and enter a project name.

Check "Allow all models" if you do not want to restrict the allowed models in your project. Otherwise, add the allowed models in the "Models (Optional)" field. Type a model name and select it, or pick one from the suggestions. Each added model appears as a tag. To remove a model, click the "x" on its tag.

Check "Allow all custom endpoints" if you do not want to restrict the allowed custom endpoints in your project. Otherwise, add the allowed endpoints in the "Custom Endpoints (Optional)" field the same way.

Check "Allow all MCP prefixes" if you do not want to restrict which DeepFellow Infra MCP servers your project's tools will reach. Otherwise, add the allowed prefixes in the "MCP Prefixes (Optional)" field the same way. The Infra MCP and Web Search tools require the matching prefix to be allowed here.

Click the "Create" button to finish. Your new project will appear on the list. You can edit project details by clicking the pencil icon.

You can also create projects programmatically.

edit project pop-up window with options to add models, custom endpoints, and MCP prefixes

Project Details

You can review project details by clicking "View Details". You can archive project details by clicking "Archive" button. You can edit project details by clicking "Edit Project" button.

A project's page groups its configuration into collapsible sections: "Overview", "Settings", "API Keys", and "Toolboxes". Click a section header to show or hide it. Go to Managing Toolboxes and Tools to read about managing toolboxes from the Web Panel.

example project page with info about models, custom endpoints and API Keys

Project API Keys

You can create a Project API Key by clicking the "Create API Key" button in a project's page.

To create one, click "Create API Key". In the pop-up, enter a name for the key and click "Create". The next pop-up will show the key value – copy and save it, you can't access it again.

To delete a Project API Key, click the trashcan icon and confirm by clicking "Delete". This action is irreversible.

You can also create Project API Keys programmatically.

pop-up window with a generated example project API Key

Managing Users

The Users section lets the administrator view, create, block, and update all user accounts on the server.

Go to the Users view using the sidebar menu:

users page in DeepFellow Web Panel with a list of active user accounts

The list shows only active (non-blocked) users. Blocked users do not appear.

Creating a User

To create a new user, click "Create User". In the form, enter the user's name, email address, and password.

Optionally, select an existing organization from the dropdown to add the user to it and set it as the user's default organization.

Click "Create" to finish. The new user will appear in the list.

create user form with email, password, and organization name fields

Changing a User's Password

To change a user's password, click the key icon next to the user and enter the new password.

edit user pop-up window with a password field

Blocking a User

To block a user, click the block icon next to the user. A confirmation dialog will appear — click "Block" to confirm.

confirmation dialog asking whether to block the selected user

Blocked users lose access to the server immediately. They are removed from the users list and can no longer authenticate.

The Web Panel does not provide a way to unblock a user. To reactivate a blocked user, call the admin API's edit-user endpoint (POST /admin/user/{user_id}) with "status": "active".

Blocking a user is immediate. The user will lose access as soon as you confirm.

Accepting an Invitation

When you invite a person who already has a DeepFellow account, they receive an email with an invitation link. The link carries the organization invitation token.

Registering Through an Invitation

When you invite a person who does not have a DeepFellow account yet, they receive an email with a registration link that opens a registration form. The form asks for a username and a password.

After a successful registration the invited user is added to the organization as a "user".

If the invited email already belongs to an existing account by the time the link is opened, the registration link behaves like a regular invitation link. See Accepting an Invitation.

Managing Toolboxes and Tools

A toolbox is a set of tools the model calls through the Model Context Protocol (MCP). To learn what toolboxes and tools are, read Using Tools. To manage toolboxes and tools from the Web Panel, you must have access to manage the project.

The Infra MCP and Web Search tools call MCP servers hosted on DeepFellow Infra. For these tools to work, the project must allow the matching MCP prefixes. Open the project's "Settings", click "Edit Project", and check "Allow all MCP prefixes", or list the specific prefixes in "MCP Prefixes (Optional)".

Edit Project dialog with Allow all MCP prefixes enabled

Open a project's page to find its "Toolboxes" section. The section is collapsible, so click its header to show or hide it.

You can also manage toolboxes and tools programmatically.

Creating a Toolbox

To create a toolbox, click "New toolbox" in the "Toolboxes" section. Enter a name and click "Create". The new toolbox appears in the list.

Create Toolbox dialog with a name field

Each toolbox row provides the following actions:

  • + Tool opens the dialog to add a tool.
  • Share opens the "Share MCP server" dialog for the toolbox.
  • Pencil opens the dialog to edit the toolbox name.
  • Trash deletes the toolbox. Deleting a toolbox also deletes the tools inside it.
  • Arrow expands the toolbox to show its tools. Toolboxes are collapsed by default.

The "Share MCP server" dialog shows the toolbox's "Server URL" and a ready-to-paste "Config" snippet for MCP clients such as Cursor or Windsurf. Click the copy icon next to either one. Each tool exposes its own Share dialog the same way. For details on connecting, including authentication and the built-in df:// protocol, read Tool Calling.

Adding a Tool

To add a tool, click "+ Tool" on a toolbox row. In the "Add Tool" dialog, select a "Tool Type" and fill in its definition. DeepFellow supports the following tool types:

  • External MCP – connects to an external MCP server.
  • Infra MCP – uses tools hosted on DeepFellow Infra.
  • Image Generation – generates images using DeepFellow Infra.
  • File Search – searches DeepFellow Server vector stores.
  • Web Search – searches web pages and fetches their content.
  • Custom MCP – wraps an HTTP request to a custom service.

Each form maps to the fields described in Tool Types. Fill in the required fields, marked with an asterisk, and click "Create" to add the tool.

Fields:

  • Server URL (required) – URL of the external MCP server.
  • Server Label (required) – name of the MCP server, used by the model. DeepFellow fills this in automatically from the server after you enter the "Server URL"; you can override it.
  • Allowed Tools – tools the model may use. If empty, all tools are allowed.
  • Headers – additional HTTP headers, useful for tool authorization.
  • Require Approval – whether tool calls need approval: "Always", "Never", or "Custom".
  • Server Description – server description, used by the model.

Selecting "Custom" for Require Approval shows two groups, "Always" and "Never". In each, add the tool names the rule applies to, or enable "Read Only" to apply it to all read-only tools.

See Tool Types for request examples.

Add Tool dialog for an External MCP tool

Fields:

  • Server Prefix (required) – prefix set up during MCP server installation on DeepFellow Infra.
  • Server Label (required) – name of the MCP server, used by the model.
  • Server Transport – MCP transport used to connect to the server: "Streamable HTTP" (default) or "SSE".
  • Allowed Tools – tools the model may use. If empty, all tools are allowed.
  • Headers – additional HTTP headers, useful for tool authorization.
  • Require Approval – whether tool calls need approval: "Always", "Never", or "Custom".
  • Server Description – server description, used by the model.

Selecting "Custom" for Require Approval shows two groups, "Always" and "Never". In each, add the tool names the rule applies to, or enable "Read Only" to apply it to all read-only tools.

See Tool Types for request examples.

Add Tool dialog for an Infra MCP tool

Fields:

  • Model (required) – model installed in DeepFellow Infra's stable diffusion service.
  • Background – "auto", "transparent", or "opaque".
  • Output Format – image format: "png", "jpeg", "webp".
  • Quality – image quality: "auto", "low", "medium", "high".
  • Size – image size: "width x height", for example "1024x1024".
  • Output Compression (0–100) – output compression as a percentage. Lower values reduce file size and quality.
  • Partial Images (0–3) – number of partial images to generate in streaming mode.

See Tool Types for the full set of API fields (including API-only options like moderation and input_image_mask) and request examples.

Add Tool dialog for an Image Generation tool

Fields:

  • Server Label (required) – MCP tool name.
  • Server Prefix (required) – prefix set up during MCP server installation on DeepFellow Infra.
  • Server Description – server description, used by the model.
  • Headers – additional HTTP headers, useful for tool authorization.
  • Require Approval – whether tool calls need approval: "Always" or "Never".
  • Custom Tools – list of tools, each with:
    • Name – tool name.
    • Title – display name.
    • Description – tool description.
    • Request – the default request: Method, Path, Query Params, Request Headers, Body.
    • Inputs – input fields: Name, Type, Description, Required, To Type ("body", "query", "header", "path"), To Param.
    • Outputs – output fields: Name, Type, Description, Required, Content Type ("text", "image", "audio"), From Param, MIME Type, From Base64.

See Tool Types for the full field descriptions and request examples.

Add Tool dialog for a Custom MCP tool, showing the server and tool fields

Viewing, Editing, and Deleting Tools

The "Toolboxes" section lists each toolbox with the number of tools it contains. Toolboxes are collapsed by default.

Toolboxes section listing collapsed toolboxes

To see a toolbox's tools, click the "Arrow" to expand it. Each tool shows its type and a short summary.

expanded toolbox listing its tools

Each tool provides the following actions:

  • Share opens the "Share MCP server" dialog for the tool.
  • Pencil opens the dialog to edit the tool. Edit the fields and click "Update".
  • Trash deletes the tool. Confirm by clicking "Delete".

We use cookies on our website. We use them to ensure proper functioning of the site and, if you agree, for purposes such as analytics, marketing, and targeting ads.