HN 日本語サマリー

← 一覧へ戻る
Web開発

Show HN: ウェブサイトに実際のLinuxターミナルを埋め込む

Show HN: Embed a real Linux terminal on your website (sandbox.bio)

9 pointsby raboukhalil6 コメント

要約

sandbox.bioは、ウェブサイトやブログ記事にライブターミナルを簡単に埋め込めるサービスを提供しています。提供されるスクリプトタグを追加するだけで、GitHub PagesやHTMLウェブサイト上でBashコードブロックを実行できる「実行」ボタンが表示されます。さらに、開始ディレクトリやリモート設定URLを指定して、ターミナルの動作をカスタマイズすることも可能です。

全文翻訳

sandbox.bioを埋め込む

ライブターミナルをあなたのウェブサイトやブログ記事に追加

一行のコードで、sandbox.bioターミナルをあなたのウェブサイトに埋め込むことができます。このターミナルには、バイオインフォマティクスツールとカスタムデータファイルがプリインストールされています。ページ上のBashコマンドには、ターミナルで実行される「実行」ボタンが自動的に表示されます。GitHub Pages、Read the Docs、Sphinx、またはプレーンHTMLに対応しています。

自分で試す

エディタでCmd+Enter(WindowsではCtrl+Enter)を押すと、プレビューが更新されます。

どのコードブロックに「実行」ボタンが表示されるか

一般的なサイトジェネレーターが生成する形式のシェルコードブロック:

  • Markdown(GitHub Pagesを含む): ```bash、```sh、または ```shell でマークされたコードブロック
  • SphinxおよびRead the Docs: .. code-block:: bash
  • HTML: <pre><code class="language-bash">、またはブロックを明示的に有効にする <pre data-sandboxbio>

コマンドプロンプトに $ が表示され、その後に実行結果が表示されるシェルブロックの場合、コマンドのみが実行されます。シェルブロックにボタンが表示されないようにするには、それに data-sandboxbio="off" を追加するか、それに隣接する要素に no-run クラスを追加してください。

オプション

スクリプトタグの属性でターミナルをカスタマイズできます。例: <script src="..." data-height="500">:

属性デフォルト機能
data-cwdページのURLに基づくターミナルが開始するフォルダ(/home/sandbox 以下)
data-height360展開されたターミナルの高さ(ピクセル単位)
data-runtrue実行ボタンを無効にするには false に設定します(例: 独自のボタンのみを使用する場合。下記参照)
data-configなしファイルをプリロードし、ターミナルをカスタマイズするための設定ファイルのURL(下記参照)。ページからの相対パスです。
ファイルのプリロード

data-config をサイト上のJSONファイルにポイントします。これはGitHub連携のsandboxbio.config.jsonと同じ形式を使用し、すべてのフィールドはオプションです:

{
  "files": [
    { "url": "data/example.bam", "path": "example.bam" }
  ],
  "tools": ["samtools"],
  "welcome": "ようこそ!example.bamは探索の準備ができています。",
  "welcomeCmd": "ls -l",
  "setup": "samtools index example.bam"
}
filesターミナルのフォルダにダウンロードするファイル。各 url は設定ファイルからの相対パスで、path はターミナルでのファイル名です。
toolsバックグラウンドでダウンロードされるツール。最初のコマンドがそれを使用する際に高速に実行されます。
welcomeターミナル開始時に表示されるメッセージ
welcomeCmdウェルカムメッセージの後に実行されるコマンド。読者が入力したかのように表示されます。
setupターミナルが表示される前に実行されるコマンド。読者からは隠されます。

ターミナルは設定ファイルとそのファイルをサイトからダウンロードするため、CORSが有効になっている必要があります。GitHub Pagesはこれを自動的に行いますが、他のホストでは Access-Control-Allow-Origin ヘッダーを追加する必要がある場合があります。

http://localhost でサイトをプレビューする場合、設定はロードされません。ブラウザはHTTPSで提供されるターミナルからHTTPアドレスのファイルをダウンロードすることを許可しないためです。代わりに公開されたサイトでテストしてください。

独自のボタンを使用する

独自のボタンやスクリプトからターミナルにコマンドを送信するには、sandboxbio.run() を呼び出します:

<button onclick="sandboxbio.run('samtools --version')">samtoolsのバージョンを確認</button>

ターミナルがロード完了する前に送信されたコマンドは無視されます。