Quellcode durchsuchen

Update extender-local-setup.md

Björn Ritzl vor 11 Monaten
Ursprung
Commit
dacb182742
1 geänderte Dateien mit 20 neuen und 12 gelöschten Zeilen
  1. 20 12
      docs/en/manuals/extender-local-setup.md

+ 20 - 12
docs/en/manuals/extender-local-setup.md

@@ -12,31 +12,37 @@ There are two variants how to run local build server (aka 'Extender'):
 ## How to run local Extender with preconfigured artifacts
 
 ### Prerequisites
-* **Docker** - https://www.docker.com/products/docker-desktop/
-* **gcloud cli** - https://cloud.google.com/sdk/docs/install
-* **google account**
+Before you can run a local cloud builder you need to install the following software:
+
+* [Docker](https://www.docker.com/) - Docker is a set of platform as a service products that use OS-level virtualization to deliver software in packages called containers. To run the cloud builders on your local development machine you need to install [Docker Desktop](https://www.docker.com/products/docker-desktop/)
+* Google Cloud CLI - The Google Cloud CLI is a set of tools to create and manage Google Cloud resources. The tools can be [installed directly from Google](https://cloud.google.com/sdk/docs/install) or from a package manager such as Brew, Chocolatey or Snap.
+* You also need a Google account to download the containers with the platform specific build servers.
 
 ### How to use ready-to-use Docker images
+Once you have the above mentioned software installed follow these steps to install and run the Defold cloud builders:
+
 **Note for Windows users**: use git bash terminal for executing commands below.
-1. Authorize to Google Cloud and create Application default credentials
+
+1. __Authorize to Google Cloud and create Application default credentials__ - You need to have a Google account when downloading the Docker container images so that we can monitor and ensure fair use of the public container registry and temporarily suspend accounts which download images excessively.
+
    ```sh
    gcloud auth application-default login
    ```
-2. Configure Docker to use Artifact registries
+2. __Configure Docker to use Artifact registries__ - Docker needs to be configured to use `gcloud` as a credential helper when downloading container images from the public container registry at `europe-west1-docker.pkg.dev`.
+
    ```sh
    gcloud auth configure-docker europe-west1-docker.pkg.dev
    ```
-3. Check that Docker is running.
-4. Check that everything set up correctly by pulling base image. Run
+3. __Verify that Docker and Google Cloud are configured correctly__ - Verify that Docker and Google Cloud are set up successfully by pulling the base image used by all of the build server container images. Make sure that Docker Desktop is running before running the command below:
    ```sh
    docker pull --platform linux/amd64 europe-west1-docker.pkg.dev/extender-426409/extender-public-registry/extender-base-env:latest
    ```
-5. Clone `Extender` repository and switch to cloned repository root folder
+4. __Clone Extender repository__ - With Docker and Google Cloud correctly set up we are almost ready to start the servers. Before we can start the server we need to clone the Git repository containing the build server:
    ```sh
    git clone https://github.com/defold/extender.git
    cd extender
    ```
-6. Download prebuilt jars:
+5. __Download prebuilt jars__ - Next step is to download the prebuilt server (`extender.jar`) and manifest merge tool (`manifestmergetool.jar`):
    ```sh
     TMP_DIR=$(pwd)/server/_tmp
     APPLICATION_DIR=$(pwd)/server/app
@@ -68,8 +74,7 @@ There are two variants how to run local build server (aka 'Extender'):
     cp ${TMP_DIR}/$(ls ${TMP_DIR} | grep server-${EXTENDER_VERSION}.jar) ${APPLICATION_DIR}/extender.jar
     cp ${TMP_DIR}/$(ls ${TMP_DIR} | grep manifestmergetool-${MANIFESTMERGETOOL_VERSION}.jar) ${APPLICATION_DIR}/manifestmergetool.jar
    ```
-7. Run docker compose:
-main command
+7. __Start the server__ - We can now start the server by running the docker compose main command:
 ```sh
 docker compose -p extender -f server/docker/docker-compose.yml --profile <profile> up
 ```
@@ -116,4 +121,7 @@ If you want to pull latest versions of jars you can use following command to det
         --sort-by="~createTime" \
         --limit=1 \
         --format="get(name)" | awk -F'/' '{print $NF}')
-```
+```
+
+## What about macOS and iOS?
+The macOS and iOS builds are done on real Apple hardware using a build server running in stand-alone mode without Docker. Instead XCode, Java and other required tools are installed directly on the machine and the build server is running as a normal Java process. You can learn how to set this up in the [build server documentation on GitHub](https://github.com/defold/extender?tab=readme-ov-file#running-as-a-stand-alone-server-on-macos).