Web

The web service embeds and serves the static files for the Infinite Scale Web Client. Note that clients will respond with a connection error if the web service is not available.

The web service also provides a minimal API for branding functionality like changing the logo shown.

• Custom Compiled Web Assets
• Web UI Configuration
  • Web UI Options
  • Web UI Config File
  • Embedding Web
• Web Apps
  • Loading Applications
  • Application Structure
  • Application Configuration
  • Using Custom Assets
• Miscellaneous
• Example Yaml Config

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 and ownCloud Web / Setup with oCIS for more details.

• Single configuration settings of the embedded web UI can be defined via WEB_OPTION_xxx environment variables.
• A json based configuration file can be used via the WEB_UI_CONFIG_FILE environment variable.
• If a json based configuration file is used, these configurations take precedence over single options set.

Besides theming, the behavior of the web UI can be configured via options. See the environment variables WEB_OPTION_xxx for more details.

When defined via the WEB_UI_CONFIG_FILE environment variable, the configuration of the web UI can be made with a json based file.

Web can be consumed by another application in a stripped down version called “Embed mode”. This mode is supposed to be used in the context of selecting or sharing resources.

For more details see the developer documentation ownCloud Web / Embed Mode. See the environment variables: WEB_OPTION_MODE and WEB_OPTION_EMBED_TARGET to configure the embedded mode.

The administrator of the environment is capable of providing custom web applications to the users. This feature is useful for organizations that want to provide third party or custom apps to their users.

It’s important to note that the feature at the moment is only capable of providing static (js, mjs, e.g.) web applications and does not support injection of dynamic web applications (custom dynamic backends).

Web applications are loaded, if added in the Infinite Scale source code, at build-time from <ocis_repo>/services/web/assets/apps. This cannot be manipulated at runtime.

Additionally, the administrator can provide custom applications by storing them in the path defined by the environment variable WEB_ASSET_APPS_PATH.

This environment variable defaults to the Infinite Scale base data directory $OCIS_BASE_DATA_PATH/web/assets/apps, but can be redefined with any path set manually.

The final list of available applications is composed of the built-in and the custom applications provided by the administrator via WEB_ASSET_APPS_PATH.

For example, if Infinite Scale would contain a built-in extension named image-viewer-dfx and the administrator provides a custom application named image-viewer-obj via the WEB_ASSET_APPS_PATH directory, the user will be able to access both applications from the WebUI.

• Applications always have to follow a strict structure.
  Everything else is skipped and not considered as an application.

  • Each application must be in its own directory accessed via WEB_ASSET_APPS_PATH.
  • Each application directory must contain a manifest.json file.

• The manifest.json file contains the following fields:

  • entrypoint - required
    The entrypoint of the application like index.js, the path is relative to the parent directory.
  • config - optional
    A list of key-value pairs that are passed to the global web application configuration apps.yaml.

If a custom configuration is needed, the administrator must provide the required configuration inside the $OCIS_BASE_DATA_PATH/config/apps.yaml file.

NOTE: An application manifest should never be changed manually, see Using Custom Assets for customisation.

The apps.yaml file must contain a list of key-value pairs which gets merged with the config field. For example, if the image-viewer-obj application contains the following configuration:

{
  "entrypoint": "index.js",
  "config": {
    "maxWidth": 1280,
    "maxHeight": 1280
  }
}

The apps.yaml file contains the following configuration:

image-viewer-obj:
  config:
    maxHeight: 640
    maxSize: 512

The final configuration for web will be:

{
  "external_apps": [
    {
      "id": "image-viewer-obj",
      "path": "index.js",
      "config": {
        "maxWidth": 1280,
        "maxHeight": 640,
        "maxSize": 512
      }
    }
  ]
}

Besides the configuration from the manifest.json file, the apps.yaml file can also contain the following fields:

• disabled - optional
  Defaults to false. If set to true, the application will not be loaded.

Besides the configuration and application registration, in the process of loading the application assets, the system uses a mechanism to load custom assets.

This is very useful for cases where just a single asset should be overwritten, like a logo or similar.

Consider the following: Infinite Scale is shipped with a default web app named image-viewer-dfx which contains a logo, but the administrator wants to provide a custom logo for that application.

This can be achieved using the path defined via WEB_ASSET_APPS_PATH and adding a custom structure like WEB_ASSET_APPS_PATH/image-viewer-dfx/. Here you can add all custom assets to load like logo.png. On loading the web app, custom assets defined overwrite default ones.

This also applies for the manifest.json file, if the administrator wants to provide a custom one.

Please note that Infinite Scale, in particular the web service, needs a restart to load new applications or changes to the apps.yaml file.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

# Autogenerated
# Filename: web-config-example.yaml

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9104
  token: ""
  pprof: false
  zpages: false
http:
  addr: 127.0.0.1:9100
  tls:
    enabled: false
    cert: ""
    key: ""
  root: /
  cache_ttl: 604800
  cors:
    allow_origins:
    - https://localhost:9200
    allow_methods:
    - OPTIONS
    - HEAD
    - GET
    - PUT
    - PATCH
    - POST
    - DELETE
    - MKCOL
    - PROPFIND
    - PROPPATCH
    - MOVE
    - COPY
    - REPORT
    - SEARCH
    allow_headers:
    - Origin
    - Accept
    - Content-Type
    - Depth
    - Authorization
    - Ocs-Apirequest
    - If-None-Match
    - If-Match
    - Destination
    - Overwrite
    - X-Request-Id
    - X-Requested-With
    - Tus-Resumable
    - Tus-Checksum-Algorithm
    - Upload-Concat
    - Upload-Length
    - Upload-Metadata
    - Upload-Defer-Length
    - Upload-Expires
    - Upload-Checksum
    - Upload-Offset
    - X-HTTP-Method-Override
    allow_credentials: false
asset:
  path: ""
  core_path: /var/lib/ocis/web/assets/core
  apps_path: /var/lib/ocis/web/assets/apps
file: ""
web:
  theme_server: https://localhost:9200
  theme_path: /themes/owncloud/theme.json
  config:
    server: https://localhost:9200
    oidc:
      metadata_url: https://localhost:9200/.well-known/openid-configuration
      authority: https://localhost:9200
      client_id: web
      response_type: code
      scope: openid profile email
      post_logout_redirect_uri: ""
    apps:
    - files
    - search
    - text-editor
    - pdf-viewer
    - external
    - admin-settings
    - epub-reader
    - draw-io
    applications: []
    external_apps:
    - id: preview
      path: web-app-preview
      config:
        mimeTypes:
        - image/tiff
        - image/bmp
        - image/x-ms-bmp
    options:
      homeFolder: ""
      openAppsInTab: false
      disablePreviews: false
      previewFileMimeTypes:
      - image/gif
      - image/png
      - image/jpeg
      - text/plain
      - image/tiff
      - image/bmp
      - image/x-ms-bmp
      - application/vnd.geogebra.slides
      accountEditLink: null
      disableFeedbackLink: false
      feedbackLink: null
      sharingRecipientsPerPage: 200
      sidebar:
        shares:
          showAllOnLoad: false
      runningOnEos: false
      cernFeatures: false
      hoverableQuickActions: false
      routing:
        idBased: true
      upload: null
      editor: null
      contextHelpersReadMore: true
      logoutUrl: ""
      loginUrl: ""
      openLinksWithDefaultApp: true
      tokenStorageLocal: true
      disabledExtensions: []
      embed: null
      userListRequiresFilter: false
      concurrentRequests:
        resourceBatchActions: 0
        sse: 0
        shares:
          create: 0
          list: 0
    styles: []
    scripts: []
    custom_translations: []
apps: {}
token_manager:
  jwt_secret: ""
gateway_addr: com.owncloud.api.gateway