This quickstart demonstrates how to create and deploy an app that displays ashort message. You can use the sample application in this quickstart for anysupported version ofPHP, by specifying the runtime versionand operating system in yourapp.yamlfile.

Before you begin

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains theresourcemanager.projects.create permission.Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Build API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains theserviceusage.services.enable permission.Learn how to grant roles.

Enable the API

Install the Google Cloud CLI.

If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

Toinitialize the gcloud CLI, run the following command:

gcloudinit

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains theresourcemanager.projects.create permission.Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Build API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains theserviceusage.services.enable permission.Learn how to grant roles.

Enable the API

Install the Google Cloud CLI.

If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

Toinitialize the gcloud CLI, run the following command:

gcloudinit

Required roles

To get the permissions that you need to complete this quickstart, ask your administrator to grant you the following IAM roles:

• App Engine Admin (roles/appengine.appAdmin) on the project
• Cloud Build Editor (roles/cloudbuild.builds.editor) on the project
• Storage Object Admin (roles/storage.objectAdmin) on the project
• Logs Viewer (roles/logging.viewer) on the project
• Service Account User (roles/iam.serviceAccountUser) on the service account
• Ask your administrator to grant the following roles for the App Engine default service account:
  • Artifact Registry Reader (roles/artifactregistry.reader) on the project
  • Cloud Build Service Account (roles/cloudbuild.builds.builder) on the project
  • Storage Object Viewer (roles/storage.objectViewer) on the project

For more information about granting roles, seeManage access to projects, folders, and organizations.

You might also be able to get the required permissions throughcustom roles or otherpredefined roles.

Additional prerequisites

1. Initialize your App Engine app with your project and choose its region:

   gcloud app create --project=[YOUR_PROJECT_ID]

   When prompted, select theregionwhere you want to locate your App Engine application.

   Caution: You cannot change an app's regiononce it has been set.

2. Install the following on your local machine:

   • Downloadand install Git.
   • InstallPHP

   • To manage dependencies,download Composer and make sure the Composer executable isinstalled globally.

Download the Hello World app

We've created a Hello World app for App Engine so you can quicklyget a feel for deploying an app to the Google Cloud.

1. Clone the Hello World sample app repository to your local machine.

   git clone https://github.com/GoogleCloudPlatform/php-docs-samples.git

   Alternatively, you candownload the sample as a zip file and extract it.

2. Change to the directory that contains the sample code.

      cd php-docs-samples/appengine/flexible/helloworld

Run Hello World on your local machine

To run the Hello World app on your local computer:

1. Install dependencies.

   composer install

2. Start a local web server.

   php -S localhost:8080 -t web/

3. In your web browser, enter the following address:

   http://localhost:8080

TheHello World message from the sample app displays on the page. In yourterminal window, pressCtrl+C to exit the web server.

Deploy and run Hello World on App Engine

1. Deploy the Hello World app by running the following command from theappengine/flexible/helloworld directory:

   gcloudappdeploy

   Learn about the optional flags.

   Commongcloud command flags

   • Include the--version flag to specify an ID that uniquely identifies that version of your app, otherwise one is generated for you. Example:--version [YOUR_VERSION_ID]
   • Include the--project flag to specify an alternate Google Cloud project ID to what you initialized as the default in thegcloud tool. Example:--project [YOUR_PROJECT_ID]

   Example:

   gcloud app deploy --version pre-prod-5 --project my-sample-app

   To learn more about deploying your app from the command line, seeTesting and Deploying Your App. For a list of all the command flags, see thegcloud app deployreference.

   OK

2. Launch your browser to view the app athttps://PROJECT_ID.REGION_ID.r.appspot.com

   gcloudappbrowse

   wherePROJECT_ID represents your Google Cloud project ID.

This time, the page that displays the Hello World message is delivered by aweb server running on an App Engine instance.

Congratulations! You've deployed your first App Engine app to theApp Engine flexible environment!

See the following sections for information about cleaning up as well as links topossible next steps that you can take.

Clean up

To avoid incurring charges, you can delete your Google Cloud project to stopbilling for all the resources used within that project.

Caution: Deleting a project has the following effects:
• Everything in the project is deleted. If you used an existing project for the tasks in this document, when you delete it, you also delete any other work you've done in the project.
• Custom project IDs are lost. When you created this project, you might have created a custom project ID that you want to use in the future. To preserve the URLs that use the project ID, such as anappspot.com URL, delete selected resources inside the project instead of deleting the whole project.
1. In the Google Cloud console, go to theManage resources page.

   Go to Manage resources

2. In the project list, select the project that you want to delete, and then clickDelete.
3. In the dialog, type the project ID, and then clickShut down to delete the project.

What's next

Learn the whole platform

Now that you know what it's like to develop and deploy App Engine apps,you can explore the rest of Google Cloud. You already have theGoogle Cloud CLI installed which gives you the tools to interact withproducts like Cloud SQL, Cloud Storage, Firestore,and more.

Learn about the App Engine flexible environment

Here are some topics to help continue your learning about App Engine:

• An overview of App Engine
• Request routing
• Request handling
• Managing instances

Hello World code review

Hello World is the simplest possible App Engine app, as it contains onlyone service, has only one version, and all of the code is located within theapp's root directory. This section describes each of the app files in detail.

index.php

Theindex.php file contains the PHP code to start a server and respond torequests. This example usesSlim,but you can use otherPHP web frameworks.

This code creates a new SlimApplication object and then defines two differentGET routes:

require_once __DIR__ . '/../vendor/autoload.php';use Psr\Http\Message\ServerRequestInterface as Request;use Psr\Http\Message\ResponseInterface as Response;use Slim\Factory\AppFactory;// Create App$app = AppFactory::create();// Display errors$app->addErrorMiddleware(true, true, true);$app->get('/', function (Request $request, Response $response) {    $response->getBody()->write('Hello World');    return $response;});$app->get('/goodbye', function (Request $request, Response $response) {    $response->getBody()->write('Goodbye World');    return $response;});// @codeCoverageIgnoreStartif (PHP_SAPI != 'cli') {    $app->run();}// @codeCoverageIgnoreEndreturn $app;

app.yaml

Theapp.yamlfile describes the following configuration for your app:

• Setsenv: flex, indicating your app uses theApp Engine flexible environment.

• Specifies the runtime used by the app.

  runtime:phpenv:flexruntime_config:document_root:weboperating_system:ubuntu22runtime_version:8.4# This sample incurs costs to run on the App Engine flexible environment.# The settings below are to reduce costs during testing and are not appropriate# for production use. For more information, see:# https://cloud.google.com/appengine/docs/flexible/php/configuring-your-app-with-app-yamlmanual_scaling:instances:1resources:cpu:1memory_gb:0.5disk_size_gb:10

  • For more information on how the PHP runtime works, seeThe PHP runtime.

  • For more details about how to design your app to take advantage of versionsand services, seeAn overview of App Engine.

  • For more details about the configuration settings for App Engine, seeConfiguring your app with app.yaml.

  composer.json

  composer.json is used to declare, install, and update application dependencies:

  {"require":{"slim/slim":"^4.0","slim/psr7":"^1.3"}}