コンテンツにスキップ
BlackOps1.xは試験的なバージョンです。Production Readyは2.xを予定しています。Releases
BlackOps
Esc
navigateopen⌘Jpreview
このページの内容

Install

ComposerからBlackOps Stable Skeletonをインストールし、初期セットアップを確認する。

BlackOps Applicationは、Packagistで公開済みのSkeletonからComposer標準のcreate-projectで作成します。Stableの手順はPHP 8.5、Composer、Docker Composeだけで完走します。Node、pnpm、Authentication、Seeder、Frontend生成はStableのInstallに含めません。

Stable 1.1.0を作成する

Versionを明示してApplicationを作成します。

composer create-project blackops/skeleton my-app 1.1.0
cd my-app

Composer ScriptはProject所有のbin/setupを実行します。.envが存在しない場合だけ.env.exampleをCopyし、var/build/var/log/を準備します。既存の.envは上書きしません。

SetupはDocker、Database、Migration、Artifact Build、Worker、Schedulerを起動しません。Applicationの状態を変える処理は、以降の明示Commandで実行します。

Project Rootで、Application ContainerとPostgreSQLを順に準備します。HostのPHP CLIとContainer CLIを混在させず、php blackopsはすべてContainer内で実行します。

docker compose build app http
docker compose up -d postgres
docker compose run --rm app php blackops database:migrate
docker compose run --rm app php blackops build:compile
docker compose up -d http
curl -i http://127.0.0.1:8080/welcome
docker compose down

期待結果はHTTP 200と次のJSONです。

{"message":"Welcome to BlackOps"}

/welcomeはStableの匿名Inline Operationなので、認証HeaderなしでHTTP 200を返します。Responseを確認したらdocker compose downで停止します。MigrationとBuildはHTTP起動へ暗黙に含まれません。

Composer Scriptを使わない場合

Script実行を禁止する環境では、同じSetupを手動で実行します。

composer create-project --no-scripts blackops/skeleton my-app 1.1.0
cd my-app
php bin/setup

bin/setupは再実行可能です。既存.envを保持したまま不足するLocal Directoryだけを確認できます。 Setup後は上記Stable Runtime手順(PostgreSQL起動、Container migration/build、匿名Welcome確認、停止)へそのまま合流します。

Release Policy

Stable 1.1.0にはProject Root blackops、Generator、Application Migration Runtime、7 Validation Attribute、FrankenPHP Worker Modeが含まれます。このWebsiteはmain Document Channelであり、Global Middleware、Authentication、Durable ActorContext、#[Authorize]、Frontend Operation Bridge等の未Release Surfaceも扱います。Stableとの差はStableとmainで明示します。

BlackOpsはExperimentalです。1.x Minor間のBackward CompatibilityとProduction Readinessを保証しません。Upgrade前にRelease NoteとUpgrade Guideを確認し、検証環境でApplicationをTestしてください。Releasesには利用可能な機能と既知の制約をまとめています。

公開済みStableを使う場合は上記提供範囲に留めてください。Quickstart and Skeletonの認証付きJourneyはRepository main Previewの再現手順から始まります。接続や起動で詰まった場合はTroubleshootingを参照してください。