linux-voice-assistant/.env.example at main · OHF-Voice/linux-voice-assistant · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# Linux-Voice-Assistant - Docker Environment Configuration
# Copy this file to .env and customize for your setup by 'cp .env.example .env'

### Specify another docker image (optional):
# LVA_IMAGE="ghcr.io/ohf-voice/linux-voice-assistant"
# LVA_IMAGE_TAG="latest"

### Enable debug mode (optional):
# ENABLE_DEBUG="1"

### List audio devices (optional):
# if enabled normal startup is disabled
# LIST_DEVICES="1"

### User ID:
# This is used to set the correct permissions for the accessing the audio device and accessing the PulseAudio socket
LVA_USER_ID="1000"
LVA_USER_GROUP="1000"

### Name for the client (optional):
# CLIENT_NAME="speaker_livingroom"

### PulseAudio socket path on the host:
# PulseAudio Server:    /run/user/1000/pulse
# Pipewire Server:      /run/user/1000/pulse/native
LVA_PULSE_SERVER="/run/user/${LVA_USER_ID}/pulse/native"
LVA_XDG_RUNTIME_DIR="/run/user/${LVA_USER_ID}"
LVA_PULSE_COOKIE="/run/user/${LVA_USER_ID}/pulse/cookie"

### Path to the preferences file (optional):
# PREFERENCES_FILE="/app/configuration/preferences.json"

### Network interface (optional):
# NETWORK_INTERFACE="eth0"

### IP-Address for the api (optional):
# HOST="0.0.0.0"

### Port for the api (optional):
# PORT="6053"

### Audio input device (optional):
# AUDIO_INPUT_DEVICE="default"

### Audio output device (optional):
# AUDIO_OUTPUT_DEVICE="default"

### Mic Gain (optional) passed as an argument to LVA will overide the value in thepreferences file on boot but can be changed at runtime in Home Assistant:
# MIC_AUTO_GAIN="0"

### Mic Noise Suppression (optional) passed as an argument to LVA will overide the value in thepreferences file on boot but can be changed at runtime in Home Assistant:
# MIC_NOISE_SUPPRESSION="0"

### Enable thinking sound (optional):
# ENABLE_THINKING_SOUND="1"

### Wake word directory (optional):
# path for custom files in docker is for example "app/wakewords/custom"
# WAKE_WORD_DIR="app/wakewords"

### Wake model (optional):
# WAKE_MODEL="okay_nabu"

### Stop model (optional):
# STOP_MODEL="stop"

### Seconds after which the timer stops ringing (optional):
# TIMER_MAX_RING_SECONDS="900"

### Refactory seconds (optional):
# REFACTORY_SECONDS="2"

### Sound files (optional):
# path for custom files in docker is for example "sounds/custom/your_soundfile.flac"
# WAKEUP_SOUND="sounds/wake_word_triggered.flac"
# TIMER_FINISHED_SOUND="sounds/timer_finished.flac"
# PROCESSING_SOUND="sounds/processing.wav"
# MUTE_SOUND="sounds/mute_switch_on.flac"
# UNMUTE_SOUND="sounds/mute_switch_off.flac"

### Enable output-only mode (optional):
# ENABLE_OUTPUT_ONLY="1"