Skip to content
satware® AI OnlyOffice MCP

Admin UI Guide

The admin interface at /admin provides a web-based management UI for templates, artifacts, credentials, and OnlyOffice instances. It is a Vue 3 + Element Plus single-page application served directly by the MCP server on port 3847.

Access and Authentication

Section titled “Access and Authentication”

  1. Navigate to the admin URL

    Open http://your-host:3847/admin in your browser.

  2. Enter the admin password

    The password is set via the ADMIN_PASSWORD environment variable. If unset, the admin UI returns HTTP 503.

    Login screen

  3. Start managing

    After login, you receive an HMAC-SHA256 signed session cookie (8h lifetime).

Templates Tab

Section titled “Templates Tab”

The Vorlagen (Templates) tab is the default view after login. It lists all registered templates with search and category filter.

Templates list - German

Templates list - English

Template Detail

Section titled “Template Detail”

Click Anzeigen (View) on any template row to open the detail drawer:

Template detail drawer

The drawer shows:

  • Metadata: ID, name, description, category, tags, default version
  • Versions: Expandable list. Each version shows template file, output format, required/optional fields, creation date, and path.
  • Actions: Fill & Generate (opens generation dialog), Delete entire template

Create a Template

Section titled “Create a Template”

Click Neue Vorlage (New template) to open the create dialog:

Create template dialog

The form fields:

Field Description
ID Unique template identifier (e.g. my_template)
Name Display name (defaults to ID)
Description Free-text description
Category Classification (e.g. hr, correspondence)
Tags (CSV) Comma-separated tags
Version Semantic version (default: 1.0)
Template file type source.docx (docxtemplater) or template.docbuilder (script)
Template file Upload the template file
Output format Primary format (e.g. docx)
Supported formats All export formats (e.g. docx, pdf)

Schema Definition

Section titled “Schema Definition”

The schema section offers three input modes:

  1. Upload schema.json: Provide a pre-written JSON Schema file
  2. Extract from DOCX: Upload a .docx with {{placeholders}} to auto-generate
  3. Tree editor / JSON code: Build the schema interactively

Schema section

The tree editor lets you add properties, set types (string, number, integer, boolean, object, array), mark fields as required, and define constraints (format, enum, default value).

Fill and Generate

Section titled “Fill and Generate”

From the template detail drawer, click Ausfuellen & Generieren (Fill & Generate) to open the generation dialog:

Fill and Generate dialog

The form fields are rendered dynamically from the template’s JSON Schema. Fill in the values and click Dokument generieren (Generate document). The server processes the request and provides a download link when complete.

Artifacts Tab

Section titled “Artifacts Tab”

The Artefakte (Artifacts) tab lists all generated document artifacts.

Artifacts tab

Each artifact shows filename, size, and creation timestamp. Click the delete icon to remove an artifact.

Credentials Tab

Section titled “Credentials Tab”

The Anmeldeinformationen (Credentials) tab manages encrypted cloud storage credentials. Credentials are AES-256-GCM encrypted at rest.

Credentials tab

Create a Credential

Section titled “Create a Credential”

Click Neue Anmeldeinformation (New credential) and select a provider type. Each provider has different required fields:

Google Drive credential

Requires: Client ID, Client Secret, Refresh Token (OAuth2 flow).

Secret fields (passwords, tokens) are masked with a show/hide toggle. Provider type cannot be changed after creation.

Instances Tab

Section titled “Instances Tab”

The Instanzen (Instances) tab manages OnlyOffice Document Server instances.

Instances tab

Each instance shows:

  • ID: Unique identifier
  • URL / Host: Connection endpoint
  • Default: Green checkmark if this is the default instance
  • Healthy: Health status (Yes/No)

Action buttons: Prufen (Check health), Als Standard festlegen (Set default), Edit, Delete.

Create an Instance

Section titled “Create an Instance”

Click Neue Instanz (New instance):

Instance create dialog

Fields:

  • ID: Unique identifier (e.g. production)
  • Name: Display name
  • Container name: Docker container name
  • Server URL: Full URL (e.g. http://localhost:8080)
  • Host: Hostname (alternative to Server URL)
  • Port: Port number (1-65535)
  • JWT Secret: Document Server JWT secret

Dark Mode

Section titled “Dark Mode”

Click the moon/sun icon in the header to toggle dark mode:

Dark mode

Section titled “Related”