ドキュメントの全ページを検索するには、2文字以上入力してください。

↑ ↓ で移動 ↵ で開く esc で閉じる

rdev の使い方

サービス

データベース、キャッシュ、検索、ファイルストレージは、サイトのすぐ隣の、お客様の環境内で動作します。rdev は、プロジェクトが初めて必要としたときに、選択したバージョンで各サービスをインストールし、動き続けるようにし、接続設定をプロジェクトの .env に書き込みます。

利用できるもの

サービス 用途 バージョン デフォルトポート
MySQL リレーショナルデータベース 8.0, 8.4, 9.7 3306
MariaDB リレーショナルデータベース 10.11, 11.4, 11.8, 12.3 3307
PostgreSQL リレーショナルデータベース。-full ビルドには pgvector、PostGIS、pgRouting、(16 以降は)TimescaleDB が含まれます 14, 15, 16, 17, 18 5432
MongoDB ドキュメントデータベース 7.0, 8.0, 9.0 27017
Redis キャッシュ、キュー、セッション 9.1 6379
Meilisearch Laravel Scout 向けの全文検索 1 7700
Typesense Laravel Scout 向けの全文検索 29, 30 8108
RustFS S3 互換のファイルストレージ。次のポートに Web コンソールがあります 1 9000
Elasticsearch 検索と分析。Scout ドライバーと Elastic クライアント向け(機械学習なしで動作) 8.19, 9 9200
Qdrant セマンティック検索などの AI 機能向けのベクトル検索 1 6333
メールキャプチャ 送信メールを捕捉し、実際の受信トレイには何も届かないようにします。SMTP 127.0.0.1:2525、ブラウザーでは https://rdev-mail.dev.test 組み込み
ダンプサーバー コードからのデバッグダンプを収集します。127.0.0.1:2304、ブラウザーでは https://rdev-dumps.dev.test 組み込み

Redis は標準の Redis プロトコルを話します。Laravel の redis ドライバーと phpredis はそのまま動作します。すべてのサービスは、環境内の 127.0.0.1 でのみ待ち受けます。RustFS のような Web コンソールには、ノートPCの接続 を通じてアクセスします。

捕捉したメールとダンプをブラウザーで見る

tailnet 上の任意のブラウザーで https://rdev-mail.dev.test を開くと、アプリが送信したメールを読めます。一覧(新しい順)、各メッセージのヘッダー、プレーンテキスト版と HTML 版、添付ファイルが表示されます。メッセージは 1 件ずつでも全件でも削除でき、新着メールは自動的に表示されます。HTML メールは、スクリプトとリモート画像をブロックした状態で表示されます。

https://rdev-dumps.dev.test には、dump() の呼び出しやその他の捕捉したイベントが、新しい順に、発生元のファイルと行とともに一覧表示されます。Clear で一覧を消去できます。

どちらのページもお客様のサーバー上で動作し、プロジェクトと同様に tailnet 経由でのみアクセスできます。データがサーバーの外に出ることはなく、プレビューがこれらを公開することもありません。rdev mail list は両方のアドレスを表示し、ノートPCアプリは Sites タブの Mail と Dumps から開きます。rdev-mail と rdev-dumps は予約済みの名前のため、プロジェクトでは使えません。

ブラウザでデータベースを開く

https://rdev-adminer.dev.test は、サーバー上のデータベース管理ツール Adminer を開きます。MySQL か PostgreSQL を選び、サーバーは 127.0.0.1、ユーザーは root(MySQL)または postgres(PostgreSQL)にして、パスワードは空のままにします。SQLite ではデータベースファイルのパスを入力します。上のページと同じく tailnet からしか開けず、rdev-adminer という名前は予約されています。rdev 1.2.0 から使えます。それより前にインストールしたサーバーでは、先に sudo rdev host update を実行してください。

プロジェクトにサービスを割り当てる

サーバーで、プロジェクトとサービスを指定します。

rdev project service shop postgres

サービスがまだ動作していない場合、rdev はインストールして起動し、プロジェクト名のデータベース(MySQL、MariaDB、PostgreSQL)またはバケット(RustFS)を作成して、接続設定をプロジェクトの .env に書き込みます。.env がないプロジェクトには、代わりに設定が表示されます。MongoDB は、コードが初めて書き込んだときにデータベースを作成します。PHP プロジェクトでは、rdev がサイトの使用する PHP バージョン用に PHP の mongodb 拡張機能もインストールします(PHP 拡張機能 を参照)。

Laravel プロジェクトに新しい MySQL、MariaDB、PostgreSQL のデータベースが作られると、rdev は php artisan migrate --force も実行します。これにより、新しいアプリがセッション、キャッシュ、キューを保持するテーブルが作成され、サイトが動作し続けます。これは作成したばかりでまだ空のデータベースに対してのみ行われ、既存のデータベースはそのまま残されます。マイグレーションが失敗した場合、サービスはそのまま残り、メッセージで理由が示されるため、ご自身で php artisan migrate を実行できます。

パネルでは、サイドバーの サーバー からサーバーを開き、サービス カードで サービスを追加 を選びます(上部、またはプロジェクトの横にあります。ダッシュボードにも同じボタンがあります)。サービスを選び、複数のバージョンがあるサービスでは バージョン も選びます。プロジェクトの行には、サーバーの進行状況が表示されます:サービスのインストールと起動、データベースの作成、.env の書き込み、マイグレーションの実行。準備ができると通知が届きます。サービスを初めてインストールする場合は数分かかることがあります。AI エージェントも MCP アクセスを通じて同じことができます。「shop 用の PostgreSQL データベース」と依頼してください。

新しいプロジェクトは、同じコマンドでサービスも割り当てられます。

rdev project add shop --git [email protected]:you/shop.git --service mysql --service redis

.env に書き込まれる内容

サービス 設定
MySQL、MariaDB、PostgreSQL DB_CONNECTION、DB_HOST、DB_PORT、DB_DATABASE、DB_USERNAME(パスワードなし:お客様の環境からのみ到達可能)
MongoDB MONGODB_URI、MONGODB_DATABASE。mongodb/laravel-mongodb パッケージ用
Redis REDIS_HOST、REDIS_PORT
Meilisearch SCOUT_DRIVER=meilisearch、MEILISEARCH_HOST
Typesense SCOUT_DRIVER=typesense、TYPESENSE_HOST、TYPESENSE_PORT、TYPESENSE_PROTOCOL、TYPESENSE_API_KEY
Elasticsearch ELASTICSEARCH_HOST(http://127.0.0.1:9200)と ELASTIC_HOST(127.0.0.1:9200)。Laravel には組み込みの Elasticsearch ドライバーがないため SCOUT_DRIVER はありません。使用するパッケージ用に設定してください
Qdrant QDRANT_HOST、QDRANT_PORT、QDRANT_URL
RustFS AWS_ACCESS_KEY_ID=rdev、AWS_SECRET_ACCESS_KEY=rdev-secret、AWS_DEFAULT_REGION、AWS_BUCKET、AWS_ENDPOINT、AWS_URL、AWS_USE_PATH_STYLE_ENDPOINT=true

.env にすでにあるこれらのキーの値は置き換えられ、ほかの行はそのまま残ります。

デスクトップアプリでデータベースを開く

ノートPCの任意のデータベースアプリ(例:TablePlus, TablePro, DBeaver, DataGrip, Beekeeper Studio, DBX, pgAdmin, MySQL Workbench, MongoDB Compass, Redis Insight)でデータベースを閲覧・編集できます。サービスは環境の内側でのみ待ち受けるため、アプリの SSH(SSH トンネル)オプションを選んでください。SSH ホストはサーバーの Tailscale アドレス(~/.ssh/config の rdev エントリの HostName)、ユーザーは dev、ポートは 22、鍵はノートPCがログインに使う SSH 鍵です。そのうえで 127.0.0.1 に、上の表のポートと認証情報で接続します。ノートPCの接続が必要です。データは tailnet を通り、rdev.cloud を経由することはありません。

手元にアプリがない、またはスマートフォンやタブレットの場合は、https://rdev-adminer.dev.test でブラウザから Adminer を開けます(上の Adminer の節を参照)。

デフォルト設定

各サービスは環境内の 127.0.0.1 でのみ待ち受けるため、環境の外からは到達できず、開発向けに設定済みです。

サービス 認証情報 補足
MySQL, MariaDB ユーザー root、パスワードなし 各プロジェクトに、その名前のデータベースが作られます(my-shop は my_shop になります)。
PostgreSQL ユーザー postgres、パスワードなし(trust 認証) Unix ソケットなし:127.0.0.1 に接続してください。上記と同様にプロジェクトごとに 1 つのデータベース。
MongoDB 認証なし データベースは、コードが最初に書き込んだときに作成されます。
Redis パスワードなし メモリ上にのみ保持:サービスを再起動すると、キャッシュ、キュー、セッションは空になります。
Meilisearch マスターキーなし 開発モード、アナリティクスはオフ。
Typesense API キー rdev-typesense CORS が有効なので、ノートPC 上のページから直接問い合わせできます。
Elasticsearch ユーザーもパスワードもなし(セキュリティオフ) 単一ノード、メモリ 512 MB。機械学習は含まれません。
Qdrant API キーなし gRPC は HTTP ポートの次のポート(6334)。テレメトリはオフ。
RustFS アクセスキー rdev、シークレットキー rdev-secret プロジェクトごとに 1 つのバケット。Web コンソールは次のポート(9001)にあります。

パネルでは、サービスの ⋯ メニューにある 構成 に、サーバーが実行しているバージョンとポートについて同じ内容が表示され、最初のプロジェクト用の .env の行もコピーできる状態で並びます。オプションを変更するには rdev service set を使います(下記参照。MySQL、MariaDB、PostgreSQL、Redis が対象)。たとえば rdev service set redis appendonly yes で、再起動後も Redis のデータを保持できます。

バージョンの選択

サービスに、@ とバージョンまたはリリースラインを追加します。

rdev project service shop [email protected]

これにより、最新の MySQL 8.0 がインストールされて切り替わります。バージョンを指定しない場合は、すでにインストールされているもの、または最新のものが使われます。インストールできるすべてのバージョンを確認するには、次を実行します。

rdev service available

各サービスは、一度に1つのバージョンが動作します。

  • MySQL と MariaDB は、リリースライン(8.0、8.4、9.7…)ごとに別々のデータを保持します。新しいラインに移行すると、古いラインのデータのコピーから開始され、新しいサーバーがそれをアップグレードします。古いラインのデータはそのまま残るため、元に戻せます。古いラインに移行すると、古いサーバーは新しいデータを読み取れないため、空のデータで開始されます。
  • PostgreSQL と MongoDB は、メジャーバージョン(PostgreSQL 14、15…、MongoDB 7、8、9)ごとに別々のデータを保持します。新しいメジャーバージョンは空で開始されます。データは pg_dump または mongodump で移行してください。
  • Meilisearch と Typesense は、バージョン変更後に、アプリから(php artisan scout:import)インデックスを再構築します。

MySQL はポート 3306、MariaDB は 3307 を使用するため、両方を同時にインストールして実行できます。プロジェクトには、正しいポートが .env に設定されます。rdev 0.2.0-beta.37 より前は、MariaDB が 3306 を使用していました。そのアップデート後は、使用しているプロジェクトの .env で DB_PORT=3307 を設定するか、rdev service set-port mariadb 3306 で古いポートを維持してください。バージョンの選択には rdev 0.2.0-beta.18 以降が必要です。

PostgreSQL 拡張機能

PostgreSQL の -full ビルドには、pgvector(AI 機能向けのベクトル検索)、PostGIS と pgRouting(地図とルート)、バージョン 16 以降では TimescaleDB(時系列)が含まれます。rdev service available に表示される完全なバージョンで選択してください。

rdev project service shop [email protected]

その後、データベースで拡張機能を有効にします。たとえばマイグレーション内で次のようにします。

CREATE EXTENSION IF NOT EXISTS vector;

postgis、pgrouting、timescaledb も同様です。ビルドに TimescaleDB が含まれている場合は、rdev が自動的にプリロードします。

サービスの管理

サーバーのページの サービス カードには、インストール済みのすべてのサービスが、バージョン、実行中かどうか、ポート、パネルから割り当てたプロジェクトとともに一覧表示されます。行の ⋯ メニューから、開始、停止、再起動、同じバージョンの再インストール(データは保持されます)、アンインストール(後のインストールのためにデータを残す、またはデータも削除する)ができます。セットアップに失敗した行は、同じメニューにその理由が表示され、再試行したり、一覧から削除したりできます。サーバーは各操作を数秒で実行し、テーブルがそれに追従します。この機能には、サーバーに rdev 0.2.0-beta.24 以降が必要です。

サーバー自体では次のとおりです。

コマンド 内容
rdev service available インストールできるバージョンを一覧表示します
rdev service start mysql / stop / restart サービスを開始、停止、再起動します
rdev service logs mysql ログの最後の数行を表示します
rdev service set-port mysql 3307 別のポートに移動します(次の再起動時)
rdev service set mysql max_connections 300 設定オプションを設定します(次の再起動時。MySQL、MariaDB、PostgreSQL、Redis)
rdev service change-version mysql 9.7.4 別のバージョンに切り替えます
rdev service uninstall mysql 9.7.4 バージョンを削除します。データも削除するには --purge を追加します

サービスは環境とともに起動します。プロジェクトを削除しても、そのデータベースは削除されません。不要になったら、ご自身で削除してください。

チームとバックアップ

Team プランでは、すべてのメンバー環境が、それぞれのプライベートなサービスの隣で、オーナーのサービスに rdev-team という名前で到達できます(チーム)。

Pro と Team の夜間データバックアップには、すべての MySQL、MariaDB、PostgreSQL、MongoDB のデータベースと ~/Code フォルダーが含まれ、パネルから復元できます(バックアップ)。MySQL と MariaDB はそれぞれのポートでバックアップされ、MongoDB はすべてのデータベースを1つのアーカイブとしてバックアップされます。検索インデックスと RustFS のバケットは、アプリとお客様ご自身のコピーから再構築されます。

一覧にないサービス

ほかのものを動かすために、当社の対応を待つ必要はありません。

  • Node.js、Python、Ruby、Go で書かれたサービス は、プロジェクトとして動作します。rdev がランタイムをインストールし、コマンドを起動し、ポートを割り当て、停止したら再起動します。

    rdev project add realtime --lang node --command "npx soketi start --port={port}"
    
  • その他のソフトウェア は、ホームフォルダーに配置します。たとえばダウンロードしたバイナリを ~/.local/bin に置き、同様にプロジェクトのコマンドから起動します。ホームフォルダーは rdev host update が保持する環境の一部です。sudo apt でほかの場所にインストールしたものは、次の環境アップデートの後になくなります。

  • 上記のサービスと同様に、バージョン、パネル、.env の設定、バックアップを含めてサポートしてほしい場合は、 サービス名と用途を添えて お問い合わせ ください。複数のお客様が必要とするサービスを追加し、進捗をお知らせします。

最初の2つは、AI エージェントにセットアップを依頼することもできます。「shop プロジェクト用に Elasticsearch を動かして」と頼んでください。