Quick Start

Quick start for the Local Speech To Text module and Local STT Worker

Installing the module

1. Open the MikoPBX web interface.

2. Go to Modules → Module marketplace.

Module marketplace

1. Find Local Speech To Text and install it.

2. Open the Installed modules tab and enable the module.

Enabling Local Speech To Text

1. Click the settings button to the right of the module version.

Opening the module page

Initial module setup

1. On the Settings tab, select the main language used in calls or leave Detect automatically selected.

2. Check Maximum recognizable recording duration, min. The default is 60 minutes.

3. Select the Recording processing window and Transcript retention. The processing window cannot exceed the retention period.

4. If necessary, add internal names and abbreviations under Recognition terms.

5. Save the settings.

Module settings

Selecting a model

1. Open the Model marketplace tab.

2. Select the model for call transcription. The default Parakeet TDT 0.6B v3 is recommended for most calls; use a WhisperKit model for languages outside Parakeet's 25 supported languages.

3. Click Save model.

The selected model is downloaded to the Mac when the worker receives its first job. Keep the Mac connected to the internet until the model and its supporting files finish downloading.

Selecting a recognition model

Creating a Worker API key

1. Open the Workers tab.

2. Click Create API key.

3. Copy the displayed token immediately. It cannot be viewed again after the page is refreshed.

Create a separate key for each Mac. One key cannot be bound to multiple worker UIDs.

Creating a Worker API key

Connecting Local STT Worker

Install and open Local STT Worker. A three-step onboarding wizard appears on first launch.

Step 1. Language

Select English or Russian as the interface language, then click Next. Changing the language may require a restart; after restarting, the onboarding wizard opens again.

Selecting the Local STT Worker language

Step 2. Connect to MikoPBX

Complete these fields:

Field	What to enter
MikoPBX address	An address such as https://pbx.example.com, without credentials in the URL.
Worker name	A recognizable Mac name that will be displayed in MikoPBX.
STT worker token	The key created on the Workers tab.

The token is stored in macOS Keychain and is never written to logs.

Configuring the MikoPBX connection

Expand Advanced settings to configure:

• TLS certificate verification;

• a custom CA PEM file;

• a custom worker UID.

Advanced MikoPBX connection settings

Click Connect and continue. The application checks the connection and validates the supplied settings.

Step 3. Ready to use

The final step displays the MikoPBX and Speech to Text status and lets you enable two options:

• Launch at login — open Local STT Worker automatically when you sign in to macOS.

• Keep worker running — resume the worker automatically after the network connection is restored or the Mac wakes from sleep.

Final Local STT Worker setup step

Click Open Local STT Worker. On the Overview page, click Start Worker if the worker is stopped. The readiness panel should display the model selected in MikoPBX.

Verifying operation

1. Make a call for which call recording is enabled.

2. Wait for a job to appear on the module's Queue tab.

3. On first use, wait for the model to download to the Mac.

4. Check local processing stages under Overview, or review events under Diagnostics.

5. Open the completed result on the Transcripts tab in MikoPBX.

Call processing on the worker Overview page

See Local STT Worker for a detailed description of the application sections.