Skip to content

Commit

Permalink
update launch commands
Browse files Browse the repository at this point in the history
  • Loading branch information
chainyo committed Oct 9, 2023
1 parent ccc9438 commit 7005b96
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
16 changes: 16 additions & 0 deletions docs/usage/launch.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,3 +84,19 @@ docker logs nginx
```

Your API should now be exposed on port 80.

## Run `only_transcription`

You can run the API in transcription only mode by setting the `asr_type` in the `.env` file to `only_transcription`.

## Run `only_diarization`

You can run the API in diarization only mode by setting the `asr_type` in the `.env` file to `only_diarization`.

## Use remote servers

You can use remote servers for transcription and diarization by setting the `asr_type` in the `.env` file to `async` and
adding URLs to the `transcribe_server_urls` and `diarize_server_urls` environment variables.

If an async server is already running, you can simply add remote servers to the list of URLs by using the endpoints,
check [Management endpoints](usage/asr/#management-endpoints) for more details.
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ extra:
nav:
- 👋 Getting Started: index.md
- 📖 Usage:
- Launch: usage/launch.md
- ENV variables: usage/env.md
- ASR Engines: usage/asr.md
- Launch: usage/launch.md
- 📚 Reference:
- Config: reference/config.md
- Services: reference/services.md
Expand Down

0 comments on commit 7005b96

Please sign in to comment.