From eb7761dae4ae4c33b55d8b7a8546469039cfc5a3 Mon Sep 17 00:00:00 2001 From: David Christofas Date: Tue, 14 Feb 2023 17:16:00 +0100 Subject: [PATCH 1/3] add a small README for the web service --- services/web/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 services/web/README.md diff --git a/services/web/README.md b/services/web/README.md new file mode 100644 index 0000000000..f4b624871e --- /dev/null +++ b/services/web/README.md @@ -0,0 +1,8 @@ +# Web service + +The web service embeds and serves the static files of the [Infinite Scale Web Client](https://github.com/owncloud/web). +It also provides a minimal API for branding functionality like changing the logo. + +# Custom compiled Web assets + +If you want to use your custom compiled web assets then you can do that by setting the `WEB_ASSET_PATH` variable to point to your compiled files. From e0efc38cbde0382fec7c4eb3c86ec6c2486ee726 Mon Sep 17 00:00:00 2001 From: David Christofas Date: Wed, 15 Feb 2023 10:21:53 +0100 Subject: [PATCH 2/3] Update services/web/README.md Co-authored-by: Michael Barz --- services/web/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/services/web/README.md b/services/web/README.md index f4b624871e..8265ed3523 100644 --- a/services/web/README.md +++ b/services/web/README.md @@ -5,4 +5,4 @@ It also provides a minimal API for branding functionality like changing the logo # Custom compiled Web assets -If you want to use your custom compiled web assets then you can do that by setting the `WEB_ASSET_PATH` variable to point to your compiled files. +If you want to use your custom compiled web client assets instead of the embedded ones, then you can do that by setting the `WEB_ASSET_PATH` variable to point to your compiled files. See [ownCloud Web / Getting Started](https://owncloud.dev/clients/web/getting-started/) and [ownCloud Web / Setup with oCIS](https://owncloud.dev/clients/web/backend-ocis/) for more details. From 9a7f2a04824a4760fb13bd3e206e467e7ec5d66c Mon Sep 17 00:00:00 2001 From: David Christofas Date: Wed, 15 Feb 2023 10:21:59 +0100 Subject: [PATCH 3/3] Update services/web/README.md Co-authored-by: Martin --- services/web/README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/services/web/README.md b/services/web/README.md index 8265ed3523..9e2cbeadc7 100644 --- a/services/web/README.md +++ b/services/web/README.md @@ -1,8 +1,10 @@ -# Web service +# Web Service -The web service embeds and serves the static files of the [Infinite Scale Web Client](https://github.com/owncloud/web). -It also provides a minimal API for branding functionality like changing the logo. +The web service embeds and serves the static files for the [Infinite Scale Web Client](https://github.com/owncloud/web). +Note that clients will respond with a connection error if the web service is not available. -# Custom compiled Web assets +The web service also provides a minimal API for branding functionality like changing the logo shown. + +## Custom Compiled Web Assets If you want to use your custom compiled web client assets instead of the embedded ones, then you can do that by setting the `WEB_ASSET_PATH` variable to point to your compiled files. See [ownCloud Web / Getting Started](https://owncloud.dev/clients/web/getting-started/) and [ownCloud Web / Setup with oCIS](https://owncloud.dev/clients/web/backend-ocis/) for more details.