linnet/docs/getting-started/installation.md

45 lines
1.2 KiB
Markdown

# Installation
Linnet requires [Docker](https://docs.docker.com/get-docker/) and Docker Compose.
## Step 1: Clone the repo
```bash
git clone https://git.opensourcesolarpunk.com/Circuit-Forge/linnet
cd linnet
```
## Step 2: Configure
```bash
cp .env.example .env
```
Open `.env` and review the defaults. Most settings work out of the box. See [Local Model Setup](llm-setup.md) for optional translation configuration.
## Step 3: Start
```bash
./manage.sh start
```
Open [http://localhost:8521](http://localhost:8521) in your browser.
The API runs at [http://localhost:8522](http://localhost:8522).
## manage.sh commands
| Command | What it does |
|---------|-------------|
| `./manage.sh start` | Start API and frontend |
| `./manage.sh stop` | Stop all services |
| `./manage.sh restart` | Stop then start |
| `./manage.sh status` | Show running services |
| `./manage.sh logs` | Tail combined logs |
| `./manage.sh open` | Open UI in default browser |
## First run
The first start downloads Whisper and wav2vec2 model weights. This takes a few minutes depending on your connection. Subsequent starts use the cached models.
Once the UI opens, grant microphone access when prompted and click **New session** to start transcribing.