diff --git a/docs/usage/launch.md b/docs/usage/launch.md index 36c21a8..d1821eb 100644 --- a/docs/usage/launch.md +++ b/docs/usage/launch.md @@ -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. diff --git a/mkdocs.yml b/mkdocs.yml index de3954f..2d63ef8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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