docs/ATTIC/3_Developer_Guides/4_X(cross)_Development_System:_User's_Guide/2_Create_your_first_AGL_application/3.4.2.4_Build_Using_the_XDS_Dashboard.md

   1 <!-- WARNING: This file is generated by fetch_docs.js using /home/boron/Documents/AGL/docs-webtemplate/site/_data/tocs/devguides/master/xds-docs-guides-devguides-book.yml -->
   2
   3 # Build Using the XDS Dashboard
   4
   5 One option for building your application using XDS is to use
   6 the XDS Dashboard.
   7 Building the application consists of using the dashboard
   8 to declare your project and then initiate the build.
   9
  10 ## Declare Project
  11
  12 Follow these steps to declare the project:
  13
  14 1. Open a Web Browser and connect to to the XDS Dashboard.
  15
  16    The URL you use depends of your configuration (e.g. `http://localhost:8800`).
  17
  18 2. Open the right sidebar and select the `Projects` entry to open the
  19    project page.
  20    Once the page is open, declare a new project by clicking on the
  21    "plus" icon next to "Add Project":
  22
  23    ![](./pictures/xds-dashboard-icon-2.png){:: style="margin:auto; display:flex"}
  24
  25    When you declare the project, XDS creates the `xds-project.conf`
  26    configuration file if one does not already exist.
  27    You should examine this configuration file before you build the
  28    project to be sure all configurations are correct for your project.
  29
  30    The configuration file can be very useful when you plan to use
  31    XDS client tools such as `xds-cli` or `xds-gdb`.
  32
  33    <!-- pagebreak -->
  34
  35 3. Set `Sharing Type` appropriately depending on your Client Part
  36    configuration:
  37
  38    ![](./pictures/xds-dashboard-prj-1.png){:: style="width:90%; max-width:560px; margin:auto; display:flex"}
  39
  40    <!-- section-note -->
  41    **NOTES:**
  42
  43    - When `Path mapping` type is selected, you must clone your project into
  44      `$HOME/xds-workspace` directory, which is named **Local Path** in the modal window.
  45
  46    - If XDS server is running in the XDS docker container
  47      the **Server Path** must be set to `/home/devel/xds-workspace/<xxx>`
  48      where `<xxx>` is your project directory name.
  49      See the "[Installation based on Docker container](server-part.html#docker-container))"
  50      section for more information.
  51
  52    - If you select `Cloud Sync`, you can clone your project wherever you want on
  53      your local disk.
  54    <!-- end-section-note -->
  55
  56 ## Build the Application
  57
  58 Building the application requires opening the build page's "build entry" in the
  59 left navigational pane, selecting both the project and the SDK, and
  60 then initiating the build.
  61
  62 <!-- section-note -->
  63 **NOTE:**
  64
  65 To use the `helloworld-native-application` example, you need to provide
  66 some configuration items.
  67 Specifically, you must pass values for both the
  68 `RSYNC_TARGET` and `RSYNC_PREFIX` environment variables.
  69 To pass these variables, use the `Settings` window in the `Build` tab.
  70 You can use the `Env variables` field to pass a list of environment variables
  71 that are set on the server prior to the build occurring.
  72 You must separate individual variables using the semi-colon character:
  73
  74 ```
  75 RSYNC_TARGET=root@<mytarget>;RSYNC_PREFIX=/opt
  76 ```
  77
  78 When you pass these variables, substitute `<mytarget>` with the valid
  79 target IP address or DNS name entry.
  80 <!-- end-section-note -->
  81
  82 Follow these steps to build the application:
  83
  84 1. Open the build page build entry in the left-hand navigation pane:
  85
  86    ![](./pictures/xds-dashboard-icon-3.png){:: style="display:inline; padding:0;"},
  87
  88 2. Select your **Project**.
  89
  90 3. Seclect the **Cross SDK** you want to use.
  91
  92 4. Click the **Clean / Pre-Build / Build / Populate** buttons to execute
  93    the build action you want.
  94
  95    ![](./pictures/xds-dashboard-prj-2.png){:: style="width:90%; max-width:600px; margin:auto; display:flex"}