From d6ef4fc0dba5088fc519334bd9caa96074fc8b0e Mon Sep 17 00:00:00 2001 From: Keirthana T S Date: Fri, 19 Jan 2024 15:24:42 +0530 Subject: [PATCH] Update creating applications and sessions --- howto/manage/web-dashboard.md | 52 ++++++++++++----------------------- 1 file changed, 18 insertions(+), 34 deletions(-) diff --git a/howto/manage/web-dashboard.md b/howto/manage/web-dashboard.md index 7b418d87..5c1ac5bb 100644 --- a/howto/manage/web-dashboard.md +++ b/howto/manage/web-dashboard.md @@ -1,29 +1,9 @@ -The Anbox Cloud Dashboard offers a web GUI from where developers can create, manage, and even stream applications from their web browser. -The dashboard is useful if you are new to Anbox Cloud or want a simple management interface. +The Anbox Cloud Dashboard offers a web GUI that developers can use to create, manage and stream applications from their web browser. You can use the pre-installed dashboard almost immediately after deploying Anbox Cloud. -[note type="information" status="Note"]The web dashboard is more oriented toward developers than end-users. However, it only uses available APIs and SDKs, and can be a good example to build your own web-based platform.[/note] +## Prerequisites +Before you can log into the dashboard, you must register your Ubuntu One account with the dashboard to authenticate. -![Anbox Cloud web dashboard|690x322](https://assets.ubuntu.com/v1/4a1c8531-manage_dashboard-applications.png) - -## Installation - -The dashboard comes pre-installed when you deploy [Anbox Cloud with the streaming stack](https://discourse.ubuntu.com/t/install-anbox-cloud/17744) or the [Anbox Cloud Appliance](https://discourse.ubuntu.com/t/install-appliance/22681). It sits behind a reverse proxy for performance and security reasons. - -## Usage - -To access the dashboard, go to `https:///`. - -The dashboard uses self-signed certificates. You might see a warning from your browser and have to accept the certificates manually. - -### Granting access - -Instead of implementing its own user management, the dashboard relies on OAuth for user authentication. The only OAuth provider supported right now is [Ubuntu One](https://login.ubuntu.com/). Future versions of Anbox Cloud will allow using other OAuth providers. - -If you haven't registered an Ubuntu One account yet, you can do that at https://login.ubuntu.com/. - -Before you can log into the dashboard, you must register your Ubuntu One account with the dashboard to grant it access. - -#### Register an Ubuntu One account in Anbox Cloud +### Register an Ubuntu One account in Anbox Cloud On a regular Anbox Cloud deployment, use the following Juju action to register an Ubuntu One account: @@ -46,7 +26,7 @@ unit-anbox-cloud-dashboard-0: ``` -#### Register an Ubuntu One account in Anbox Cloud Appliance +### Register an Ubuntu One account in Anbox Cloud Appliance If you followed the instructions in the [Install the Anbox Cloud Appliance on a dedicated machine](https://discourse.ubuntu.com/t/install-appliance/22681) tutorial or in [How to install the Anbox Cloud Appliance](https://discourse.ubuntu.com/t/how-to-install-the-anbox-cloud-appliance/29702), you already registered your Ubuntu One account. @@ -54,26 +34,30 @@ To add more accounts, use the following command: anbox-cloud-appliance dashboard register -Accessing the resulting link will create the account and ask you to login via Ubuntu One. You only need to do this step once per user you want to grant access to the dashboard. +Accessing the resulting link will create the account and ask you to login via Ubuntu One. You only need to do this step once per user for access to the dashboard. The generated link is valid for one hour. +## Using the dashboard +To access the dashboard, go to `https:///`. The dashboard uses self-signed certificates. You might see a warning from your browser and have to accept the certificates manually. + ### Creating applications -Creating applications through the dashboard is done the same way as you would do with `amc` (see [How to create an application](https://discourse.ubuntu.com/t/create-an-application/24198)). -Note that more advanced scenarios might not yet be possible via the dashboard and require going through `amc`. +Before creating an application, you need the following: +* An application manifest. A default application manifest is available based on the *Resource type* you choose for your application. You can customise various attributes of your application including the resource requirements for your application. +* Optionally, an Android package with support for the target architecture. -![Create an application|690x438](https://assets.ubuntu.com/v1/40dda4a6-manage_dashboard-add-application.png) +To create an application using the dashboard, use the *Add application* button on the *Applications* list screen, enter the required and any optional details that you want to provide and select *Add application*. This screen also provides the option to customise your application manifest. -### Streaming applications +There may be more advanced scenarios while creating an application that cannot be performed using the dashboard and may require using the `amc` CLI. See [How to create an application](https://discourse.ubuntu.com/t/create-an-application/24198) for more information. -The dashboard comes with in-browser streaming capabilities through WebRTC. It uses the [Streaming SDK](https://discourse.ubuntu.com/t/anbox-cloud-sdks/17844#streaming-sdk) under the hood. +### Streaming applications -You can select any application you previously created and start a streaming session. +The dashboard has in-browser streaming capabilities through WebRTC. It uses the [Streaming SDK](https://discourse.ubuntu.com/t/anbox-cloud-sdks/17844#streaming-sdk). -![Start a streaming session|690x352](https://assets.ubuntu.com/v1/6087fbd9-gs_dashboard_start_session.png) +You can start a streaming session for any of the successfully created applications. An application is ready to be streamed when its *Status* is *Ready*. When you select the *Start a new session* icon for an application, you can specify the desired streaming attributes such as the screen resolution, frame rate, screen orientation before launching the session. -For more information about the Streaming Stack, visit [About application streaming](https://discourse.ubuntu.com/t/streaming-android-applications/17769). +To understand how the streaming stack of Anbox Cloud works, see [About application streaming](https://discourse.ubuntu.com/t/streaming-android-applications/17769). #### Streaming statistics