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.