Frieren: セキュリティガジェットのためのマイクロフレームワーク

説明

Frieren は、OpenWrt ルーターとシングルボードコンピューター（SBC）上でセキュリティツールを実行するためのフレームワークです。WiFi 管理、インストール可能なモジュール、統合ターミナル、パッケージマネージャーを備えた Web パネルを提供します。スタックは PHP バックエンド API と React フロントエンドで構成され、組込みデバイスでも動作する軽量さを保ちながら、サードパーティ製モジュールによる拡張が可能な設計です。

機能

• WiFi 管理 — ワイヤレスインターフェースの作成、編集、削除。ネットワークのスキャン、無線の設定、UCI 設定の直接編集。
• ネットワーク — ネットワークインターフェースの管理、DHCP リースの表示、接続診断の実行。
• モジュールシステム — リモートリポジトリからサードパーティ製モジュールのインストール、削除、固定。モジュールは UMD バンドルとして動的に読み込まれます。
• パッケージマネージャー — Web パネルから直接 opkg パッケージのインストールと削除が可能。
• 統合ターミナル — パネルからアクセスできる Web ベースのターミナル（ttyd）。
• システムツール — システム統計、USB デバイス一覧、ファイルシステム使用状況、syslog ビューアー、診断、init.d サービス制御を備えたダッシュボード。
• 設定 — ホスト名、タイムゾーン、ユーザーパスワード、パネルのテーマを設定。
• 拡張性 — frieren-module-template で新しいモジュールをスキャフォールドできます。各モジュールは PHP コントローラー + React フロントエンドで構成。

コンポーネント

• frieren-back — PHP マイクロフレームワーク。セッション認証、CSRF、UCI 設定統合、ミニ ORM を備えた JSON POST API。
• frieren-front — React SPA（Vite、Wouter、Jotai、React Query）。動的な UMD モジュールの読み込みをサポート。
• frieren-module-template — window グローバルを介した共有依存関係を持つサードパーティ製モジュールを開発するためのスキャフォールディングツール。
• frieren-terminal — フロントエンドにバンドルされる TypeScript/xterm.js ライブラリ @frieren/terminal-core。ライブ ttyd ターミナルクライアント、読み取り専用ログビューアー、共有ターミナルテーマを提供。
• tools — 開発用ヘルパー: 開発 API プロキシ、デバイスデプロイスクリプト、API テストクライアント、PHP ミニファイア。

関連リポジトリ

• Frieren Modules: frieren-module-template に基づくコミュニティ開発のモジュールを収録。このリポジトリは、追加機能で Frieren インストールの機能を拡張したいユーザー向けのリソースです。
• Frieren Release: プリコンパイル済みバージョンの Frieren を展開するためのインストーラーをホスト。このリポジトリは、ビルドプロセスを経ずに Frieren をすばやく簡単にインストールしたいユーザーに最適です。
• Frieren Modules Release: モジュールカタログのビルドパイプライン — modules.json インデックスと、パネルがインストールするモジュールごとのリリース tarball を生成します。

インストール

Frieren は OpenWrt（フォークではなく公式ビルド）上で動作します。自動スクリプトでインストールするか、手動でコンパイルすることができます。

クイックインストール

すばやく簡単にインストールするには、ターミナルで次のコマンドを実行してください。このスクリプトが必要なすべての設定とセットアップ手順を処理します：

wget -qO- https://raw.githubusercontent.com/xchwarze/frieren-release/master/install/install-openwrt.sh | sh

初めてですか？ここから始めましょう。 OpenWrt が何か、フラッシュの仕方、または その後にパネルを開く方法がわからない場合は、初心者向けのステップバイステップガイド インストール FAQ に従ってください。初期状態のデバイスからログインまで、 すべてを順を追って説明します。

手動コンパイル

Frieren プロジェクト内の各コンポーネント（frieren-back、frieren-front、frieren-module-template）には、それぞれ固有のビルド手順とインストール手順を記載した詳細な README.md ファイルがあります。より詳細なガイダンスについては、各ディレクトリ内のこれらのファイルを参照してください。

モジュール開発

frieren-module-template を使用して新しいモジュールをスキャフォールドします。yarn wizard を実行して新しいモジュールをセットアップし、機能を開発してから、yarn build で UMD バンドルをコンパイルします。詳細はモジュールテンプレート README を参照してください。

ライセンス

このプロジェクトは PolyForm Noncommercial License 1.0.0 の下でライセンスされています。

非営利目的の使用は許可されています。このライセンスでは営利目的の使用は許可されていません。 営利目的での使用には、作者からの別途商用ライセンスが必要です。

商用ライセンスについては、[email protected] までお問い合わせください。

コントリビューション

コントリビューションを歓迎します — 新機能、バグ修正、モジュールなど。ビルド手順は各コンポーネントの README を参照してください。

著作者

• リードデベロッパー: DSR! - [email protected]

開発をサポート

Frieren が役立つと思われたなら、開発の支援をご検討ください。寄付はテスト用ハードウェアと継続的な開発の資金になります。Binance での送金、または独占的なアップデートとビルドが得られる Patreon への参加でサポートできます。