diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 93 |
1 files changed, 93 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..8c16128 --- /dev/null +++ b/README.md @@ -0,0 +1,93 @@ +# Ollama Translations + +Firefox用WebExtension（Manifest V3）。Webページ上で選択した文字列を、ローカルで動作するOllama LLMで翻訳し、選択箇所付近の小型ポップオーバーへストリーミング表示します。 + +## 特徴 + +- 文字列選択後、選択範囲付近に翻訳アイコンを表示（押すまでOllamaへは一切通信しません） +- Ollama REST API（`POST /api/chat`）+ NDJSONストリーミングで逐次表示 +- 会話履歴なしの1-shot翻訳。同時実行は1件で、新規要求時に旧要求を自動Abort +- Shadow DOMベースのUIでページCSSの影響を受けません +- 翻訳結果はプレーンテキストとして描画（HTML評価なし） +- コピー / 再生成 / 閉じる操作に対応 +- 詳細な生成パラメータ設定（temperature / context length / seed / top_k 等） + +## セキュリティ方針 + +- 依存パッケージゼロ（npm / Node.js 不要）。すべてバニラJS +- Ollama通信はBackgroundのみ。Content Scriptからは直接fetchしません +- 接続先は `http://localhost:<port>` / `http://127.0.0.1:<port>` のみ許可（validator + client側の二重防御） +- LLM出力・ページ文字列は `textContent` のみで描画（innerHTML不使用） +- `eval` / `new Function` / リモートコード不使用 +- 権限は `storage` + localhost系host permissionのみ + +詳細は `doc/Security.md` を参照してください。 + +## ビルド + +Node.js不要。PowerShellのみでパッケージ化できます。 + +```powershell +# アイコン生成（初回のみ、既に生成済みなら不要） +pwsh -NoProfile -File tools/make-icons.ps1 + +# パッケージ (dist/ollama-translations.zip) +pwsh -NoProfile -File build.ps1 +``` + +## Firefoxへのロード（一時アドオン） + +1. Firefoxで `about:debugging#/runtime/this-firefox` を開く +2. 「一時的なアドオンを読み込む…」をクリック +3. 本リポジトリの `manifest.json` を選択 + +## Ollamaの準備 + +1. [Ollama](https://ollama.com/) をインストールし、`ollama serve`（またはアプリを起動）で `http://localhost:11434` を立ち上げる +2. 翻訳用モデルをpullする（例）: + +```powershell +ollama pull llama3.2 +``` + +3. 拡張機能のオプション画面（ツールバーアイコン → 「詳細設定を開く」）でモデルを選択して保存 + +## テスト + +ブラウザで `tests/test.html` を開くと単体・結合テスト（71件）が実行されます。オプション画面下部の「開発者向け: テストを実行」リンクからも開けます。 + +テストは npm / Node.js を使わず、自作ランナーでブラウザ内実行されます。 + +## 使用WebExtensions API一覧 + +| API | 用途 | +|---|---| +| `storage.local` | 設定の保存・復元 | +| `storage.onChanged` | 設定変更通知（Content/Background同期） | +| `runtime.connect` / `runtime.Port` | 翻訳ストリーミング通信 | +| `runtime.sendMessage` / `onMessage` | モデル一覧取得（popup/options） | +| `runtime.openOptionsPage` | オプション画面起動 | +| `content_scripts`（manifest宣言） | ページへの注入 | + +## 要求permissionsと理由 + +| 権限 | 理由 | +|---|---| +| `storage` | 設定の永続化（EN-01/Spec §5） | +| `http://localhost/*`, `http://127.0.0.1/*` | ローカルOllamaへのfetch。Firefoxはmatch patternでポート番号指定不可（bug 1362809/1468162）のため任意ポート一致とし、実際の接続先はアプリ側validatorでlocalhost/127.0.0.1のみに制限 | + +## 既知の制限（初期版） + +- iframe内の選択文字列には非対応 +- Firefox内蔵PDF Viewer・Reader View・about:系ページには非対応 +- 翻訳履歴・チャットUIなし +- Markdown/HTMLリッチレンダリングなし（プレーンテキストのみ） +- Chrome/Edge非対応（Firefox優先） +- `tfs_z` / `mirostat*` オプション未対応 + +## ドキュメント + +- `doc/Specifications.md` — 機能仕様 +- `doc/Design.md` — 設計 +- `doc/Security.md` — セキュリティ規定 +- `doc/Testing-Results.md` — テスト実行結果
\ No newline at end of file |