summaryrefslogtreecommitdiff
path: root/README.md
blob: 4f70b41496cebd21e149426b257edab53e101333 (plain)
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
# ollama-web

Ollama を用いた Web アプリケーションプロジェクト。

## セットアップ

```bash
# 仮想環境の作成
uv venv .venv

# 依存パッケージのインストール
uv pip install -r requirements.txt -p .venv

# 開発用パッケージのインストール
uv pip install -e ".[dev]" -p .venv
```

## プロジェクト構成

```
ollama-web/
├── src/
│   └── ollama_web/        # メインパッケージ
│       ├── __init__.py
│       └── main.py        # エントリポイント
├── tests/                 # テストコード
├── docs/                  # ドキュメント
├── scripts/               # スクリプト類
├── .gitignore
├── pyproject.toml         # プロジェクト設定 (ruff, pytest, mypy 等)
├── requirements.txt       # 本番依存パッケージ
└── README.md
```

## 使い方

```bash
# アプリケーションの実行
ollama-web

# LAN内のスマホ等からアクセスする場合
# PINを固定し、待受アドレスを明示してください
OLLAMA_WEB_PIN=123456 OLLAMA_WEB_HOST=0.0.0.0 ollama-web

# テストの実行
pytest

# リント
ruff check .

# 型チェック
mypy src/
```

## セキュリティ設定

- 既定の待受は `127.0.0.1` です。LAN公開する場合だけ `OLLAMA_WEB_HOST=0.0.0.0` を指定してください。
- `OLLAMA_WEB_PIN` 未設定時は起動ごとにランダムPINが表示されます。
- CORSは既定で無効です。必要な場合のみ `OLLAMA_WEB_ALLOWED_ORIGINS` に許可オリジンをカンマ区切りで指定してください。
- Cookie署名鍵は `OLLAMA_WEB_SECRET_KEY` で固定できます。

## ライセンス

MIT