Enhance Livekit server documentation to include additional features, QR code generation command, and exposure options via ngrok.
This commit is contained in:
parent
c6e7be04a0
commit
1468a92980
|
@ -8,6 +8,7 @@ description: "A robust, feature-rich voice server for your 01"
|
||||||
[Livekit](https://livekit.io/) is a powerful, open-source WebRTC server and client SDK that enables real-time audio communication. It's designed for applications that require robust, scalable real-time features.
|
[Livekit](https://livekit.io/) is a powerful, open-source WebRTC server and client SDK that enables real-time audio communication. It's designed for applications that require robust, scalable real-time features.
|
||||||
|
|
||||||
### Key Features
|
### Key Features
|
||||||
|
|
||||||
- Scalable architecture
|
- Scalable architecture
|
||||||
- Extensive documentation and community support
|
- Extensive documentation and community support
|
||||||
- SDKs for various languages and platforms (web, mobile, desktop)
|
- SDKs for various languages and platforms (web, mobile, desktop)
|
||||||
|
@ -15,6 +16,7 @@ description: "A robust, feature-rich voice server for your 01"
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
Make sure you have navigated to the `software` directory before proceeding.
|
Make sure you have navigated to the `software` directory before proceeding.
|
||||||
|
|
||||||
### Installing Livekit
|
### Installing Livekit
|
||||||
|
@ -22,11 +24,13 @@ Make sure you have navigated to the `software` directory before proceeding.
|
||||||
Before setting up the environment, you need to install Livekit. Follow the instructions for your operating system:
|
Before setting up the environment, you need to install Livekit. Follow the instructions for your operating system:
|
||||||
|
|
||||||
- **macOS**:
|
- **macOS**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
brew install livekit
|
brew install livekit
|
||||||
```
|
```
|
||||||
|
|
||||||
- **Linux**:
|
- **Linux**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
curl -sSL https://get.livekit.io | bash
|
curl -sSL https://get.livekit.io | bash
|
||||||
```
|
```
|
||||||
|
@ -50,7 +54,11 @@ Replace the placeholders with your actual API keys.
|
||||||
<Card title="Eleven Labs" icon="microphone" href="https://beta.elevenlabs.io">
|
<Card title="Eleven Labs" icon="microphone" href="https://beta.elevenlabs.io">
|
||||||
Get your Eleven Labs API key for text-to-speech
|
Get your Eleven Labs API key for text-to-speech
|
||||||
</Card>
|
</Card>
|
||||||
<Card title="Deepgram" icon="waveform-lines" href="https://console.deepgram.com">
|
<Card
|
||||||
|
title="Deepgram"
|
||||||
|
icon="waveform-lines"
|
||||||
|
href="https://console.deepgram.com"
|
||||||
|
>
|
||||||
Obtain your Deepgram API key for speech recognition
|
Obtain your Deepgram API key for speech recognition
|
||||||
</Card>
|
</Card>
|
||||||
<Card title="Ngrok" icon="wifi" href="https://dashboard.ngrok.com">
|
<Card title="Ngrok" icon="wifi" href="https://dashboard.ngrok.com">
|
||||||
|
@ -66,8 +74,30 @@ To start the Livekit server, run the following command:
|
||||||
poetry run 01 --server livekit
|
poetry run 01 --server livekit
|
||||||
```
|
```
|
||||||
|
|
||||||
|
To generate a QR code for scanning
|
||||||
|
|
||||||
|
```bash
|
||||||
|
poetry run 01 --server livekit --qr
|
||||||
|
```
|
||||||
|
|
||||||
|
To expose over the internet via ngrok
|
||||||
|
|
||||||
|
```bash
|
||||||
|
poetry run 01 --server livekit --expose
|
||||||
|
```
|
||||||
|
|
||||||
|
In order to use the mobile app over the web, use both flags
|
||||||
|
|
||||||
|
```bash
|
||||||
|
poetry run 01 --server livekit --qr --expose
|
||||||
|
```
|
||||||
|
|
||||||
<Note>
|
<Note>
|
||||||
Currently, our Livekit server only works with Deepgram and Eleven Labs. We are working to introduce all-local functionality as soon as possible. By setting your profile (see [Configure Your Profile](/software/configure)), you can still change your LLM to be a local LLM, but the `interpreter.tts` value will be ignored for the Livekit server.
|
Currently, our Livekit server only works with Deepgram and Eleven Labs. We are
|
||||||
|
working to introduce all-local functionality as soon as possible. By setting
|
||||||
|
your profile (see [Configure Your Profile](/software/configure)), you can
|
||||||
|
still change your LLM to be a local LLM, but the `interpreter.tts` value will
|
||||||
|
be ignored for the Livekit server.
|
||||||
</Note>
|
</Note>
|
||||||
|
|
||||||
## Livekit vs. Light Server
|
## Livekit vs. Light Server
|
||||||
|
@ -96,4 +126,4 @@ Livekit provides SDKs for various programming languages and platforms, allowing
|
||||||
href="https://docs.livekit.io/client-sdk-js/"
|
href="https://docs.livekit.io/client-sdk-js/"
|
||||||
>
|
>
|
||||||
Find documentation and integration guides for all Livekit SDKs.
|
Find documentation and integration guides for all Livekit SDKs.
|
||||||
</Card>
|
</Card>
|
||||||
|
|
Loading…
Reference in New Issue