Proxy

  • The admin documentation for this service contains the full service description, configuration, and administration details. The content there is valid for both administrators and developers.

  • Anything that is relevant only for developers is described on this page.

Developer Readme

Here you can find the developer README.md for this service on the master branch. Please note that the README is intended for developers and may differ from the description in the admin documentation. Admin Docs provides information that has had specific, developer-only information removed, but it may contain additional administrative or configuration notes relevant to this service.

Developer Topics

Configuring Routes

The proxy handles routing to all endpoints that oCIS offers. The currently available default routes can be found in the source code. Changing or adding routes can be necessary when writing own oCIS extensions.

Due to the complexity when defining routes, these can only be defined in the YAML config file and not via environment variables.

To overwrite default routes:

policies:
  - name: ocis
    routes:
      - endpoint: /
        service: com.owncloud.web.web
      - endpoint: /dav/
        service: com.owncloud.web.ocdav

To add additional routes to the default routes:

additional_policies:
  - name: ocis
    routes:
      - endpoint: /custom/endpoint
        service: com.owncloud.custom.custom

A route has the following configurable parameters:

endpoint: ""       # the URL that should be routed
service: ""        # the service the URL should be routed to
unprotected: false # false (default): calling the endpoint requires authorization
                   # true: anyone can call the endpoint without authorization