Added doker compose
This commit is contained in:
54
README.md
54
README.md
@@ -164,7 +164,59 @@ All options can be set via CLI flags or environment variables.
|
||||
| `--oidc-client-secret` | `FURUMI_PLAYER_OIDC_CLIENT_SECRET` | — | OIDC client secret |
|
||||
| `--oidc-redirect-url` | `FURUMI_PLAYER_OIDC_REDIRECT_URL` | — | OIDC redirect URL |
|
||||
| `--oidc-session-secret` | `FURUMI_PLAYER_OIDC_SESSION_SECRET` | *(random)* | Session HMAC secret |
|
||||
|
||||
|
||||
## Docker Compose
|
||||
|
||||
The easiest way to run the entire backend stack (PostgreSQL, Agent, Web Player, and gRPC Server) is using Docker Compose.
|
||||
|
||||
### Quick Start
|
||||
|
||||
1. **Prepare directories**:
|
||||
```bash
|
||||
mkdir -p inbox storage
|
||||
```
|
||||
2. **Start the services**:
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
3. **Check logs**:
|
||||
```bash
|
||||
docker compose logs -f
|
||||
```
|
||||
|
||||
The following services will be available:
|
||||
- **Web Player**: [http://localhost:8085](http://localhost:8085)
|
||||
- **Agent Admin UI**: [http://localhost:8090](http://localhost:8090)
|
||||
- **Metrics**: [http://localhost:9090/metrics](http://localhost:9090/metrics)
|
||||
|
||||
> [!NOTE]
|
||||
> The Agent expects Ollama to be running. By default, it tries to connect to the host at `http://localhost:11434`.
|
||||
|
||||
### Reference Commands
|
||||
|
||||
- **Start**: `docker compose up -d`
|
||||
- **Stop**: `docker compose stop`
|
||||
- **Stop and remove containers**: `docker compose down`
|
||||
- **Clear database and storage**: `docker compose down -v`
|
||||
|
||||
### Environment Variables
|
||||
|
||||
To configure the Agent (especially for remote Ollama or private models) and database, create an `.env` file in the root directory:
|
||||
|
||||
```env
|
||||
# Database
|
||||
POSTGRES_PASSWORD=secure-password
|
||||
|
||||
# LLM (Ollama)
|
||||
OLLAMA_URL=http://your-ollama-host:11434
|
||||
OLLAMA_AUTH="Bearer your-token"
|
||||
|
||||
# Server Security
|
||||
FURUMI_TOKEN=secure-server-token
|
||||
```
|
||||
|
||||
For more options, refer to the [Configuration](#configuration) section.
|
||||
|
||||
## Docker
|
||||
|
||||
Pre-built images are available on Docker Hub:
|
||||
|
||||
Reference in New Issue
Block a user