kodehat/portkey

これは何？

主な機能

• 01リンクを名前付きのグループに整理して、スタートページとして表示できます。
• 02キーワードを設定でき、あいまい検索も任意で有効にできます。
• 03外部リンクのfaviconを自動で取得し、キャッシュします。
• 04ポータルのアイコンには、絵文字、画像ファイル、URLを指定できます。
• 05指定したパスにカスタムHTMLページを追加できます。
• 06設定はYAMLファイル1つにまとめられ、環境変数で上書きできます。

ユースケース

• よく使う社内ツールやサイトをまとめた、ブラウザーのスタートページとして使う。
• ホームサーバーやイントラネットで、チーム共有のリンクダッシュボードを運用する。
• リソース一覧に添えて、簡単なカスタム情報ページを公開する。

クイックスタート

1. 1

   お使いのOS用のportkeyファイルをダウンロードし、PATHに配置します

2. 2

   config.ymlを作成するか、リポジトリのサンプル設定を使用します

3. 3

   設定ファイルのパスを指定してアプリケーションを起動します（config.ymlが作業ディレクトリにある場合は省略できます）

   portkey --config-path=<dir_to_config_yml>
4. 4

   定義されたホストとポートでブラウザーを開きます。デフォルトはhttp://localhost:3000です

使う前に知っておきたいこと

• !AGPL-3.0ライセンスで提供されています。強いコピーレフトライセンスであり、改変してネットワーク経由で提供するバージョンにも適用されます。
• !アイコンのない外部ポータルについては、ファビコンを取得するために外部へのHTTPリクエストを送信します。

収録されている特集

トピック

よくある質問

portkey とは？

リンク集を検索できる軽量なセルフホスト型スタートページ。設定ファイル1つで、リンクやシンプルなカスタムページをまとめて管理できます。 portkeyは、ブラウザーのスタートページや個人用リンクダッシュボードとして使えるWebポータルです。リンクを1つのconfig.ymlファイルに記述し、必要に応じて名前付きのセクションに分類すると、検索機能とダークモード／ライトモードを備えたホームページとして表示されます。

portkey は無料で使えますか？ライセンスは？

portkey は AGPL-3.0 ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

portkey は今もメンテナンスされていますか？

活発にメンテナンス中。portkey の最終コミットは 2026年11月6日 です。

portkey は何に使えますか？

よく使う社内ツールやサイトをまとめた、ブラウザーのスタートページとして使う。 ホームサーバーやイントラネットで、チーム共有のリンクダッシュボードを運用する。 リソース一覧に添えて、簡単なカスタム情報ページを公開する。

portkey のインストール方法は？

お使いのOS用のportkeyファイルをダウンロードし、PATHに配置します config.ymlを作成するか、リポジトリのサンプル設定を使用します 設定ファイルのパスを指定してアプリケーションを起動します（config.ymlが作業ディレクトリにある場合は省略できます）: portkey --config-path=<dir_to_config_yml> 定義されたホストとポートでブラウザーを開きます。デフォルトはhttp://localhost:3000です

portkey はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/kodehat/portkey