Extensions

How to build and run ocis-simple

ocis uses build tags to build different flavors of the binary. In order to work on a new extension we are going to reduce the scope a little and use the simple tag. Let us begin by creating a dedicated folder:

mkdir ocis-extension-workshop && ocis-extension-workshop

Following https://github.com/owncloud/ocis

git clone https://github.com/owncloud/ocis.git
cd ocis

TAGS=simple make generate build

Q: Can you specify which version of ownCloud Web to use? A: No, the ownCloud Web that is used is compiled into the assets of ocis-web which is currently not automatically updated. We’ll see how to use a custom ownCloud Web later.

bin/ocis server

Open the browser at http://localhost:9100

  1. You land on the login screen. click login
  2. You are redirected to an idp at http://localhost:9140/oauth2/auth with a login mask. Use einstein:relativityto login (one of the three demo users)
  3. You are redirected to http://localhost:9100/#/hello the ocis-hello app
  4. Replace World with something else and submit. You should see Hello %something else%

Q: One of the required ports is already in use. Ocis seems to be trying to restart the service over and over. What gives? A: Using the ocis binary to start the server will case ocis to keep track of the different services and restart them in case they crash.

Hacking ocis-hello

go back to the ocis-extension-workshop folder

cd ..

Following https://github.com/owncloud/ocis-hello

git clone https://github.com/owncloud/ocis-hello.git
cd ocis-hello

yarn install
# this actually creates the assets
yarn build

# this will compile the assets into the binary
make generate build

Two options:

  1. run only the necessary services from ocis and ocis-hello independently
  2. compile ocis with the updated ocis-hello

Option 1:

get a list of ocis services:

ps ax | grep ocis

Try to kill ocis hello

Remember: for now, killing a service will cause ocis to restart it. This is subject to change.

In order to be able to manage the processes ourselves we need to start them independently:

bin/ocis server starts the same services as:

bin/ocis micro &
bin/ocis web &
bin/ocis hello &
bin/ocis reva &

Now we can kill the ocis hello and use our custom built ocis-hello binary:

cd ../ocis-hello
bin/ocis-hello server

Hacking ownCloud Web (and ocis-web)

Following https://github.com/owncloud/web we are going to build the current ownCloud Web

git clone https://github.com/owncloud/web.git
cd web

yarn install
yarn dist

We can tell ocis to use the compiled assets:

Kill ocis web, then use the compiled assets when starting ownCloud Web.

cd ../ocis
WEB_ASSET_PATH="`pwd`/../web/dist" bin/ocis web

The ownCloud design system

The ownCloud design system contains a set of ownCloud vue components for ownCloud Web or your own ocis extensions. Please use it for a consistent look and feel.

External ownCloud Web apps

This is what hello is: copy and extend!

  1. ownCloud Web is configured using the config.json which is served by the ocis-web service (either bin/ocis web or bin/web server)

  2. point ocis-web to the web config which you extended with an external app: WEB_UI_CONFIG="pwd/../web/config.json" ASSET_PATH="pwd/../web/dist" bin/ocis web

{
  "server": "http://localhost:9140",
  "theme": "owncloud",
  "version": "0.1.0",
  "openIdConnect": {
    "metadata_url": "http://localhost:9140/.well-known/openid-configuration",
    "authority": "http://localhost:9140",
    "client_id": "web",
    "response_type": "code",
    "scope": "openid profile email"
  },
  "apps": [],
  "external_apps": [
    {
      "id": "hello",
      "path": "http://localhost:9105/hello.js",
      "config": {
        "url": "http://localhost:9105"
      }
    },
    {
      "id": "myapp",
      "path": "http://localhost:6789/superapp.js",
      "config": {
        "backend": "http://someserver:1234",
        "myconfig": "is awesome"
      }
    }
  ]
}

ownCloud Web extension points

For an up to date list check out the ownCloud Web documentation.

Several ones available:

ownCloud Web

  • App switcher (defined in config.json)
  • App container (loads UI of your extension)

Files app

  • File action
  • Create new file action
  • Sidebar
  • Quick access for sidebar inside of file actions (in the file row)

Example of a file action in the app.js:

const appInfo = {
  name: 'MarkdownEditor',
  id: 'markdown-editor',
  icon: 'text',
  isFileEditor: true,
  extensions: [{
    extension: 'txt',
    newFileMenu: {
      menuTitle ($gettext) {
        return $gettext('Create new plain text file…')
      }
    }
  },
  {
    extension: 'md',
    newFileMenu: {
      menuTitle ($gettext) {
        return $gettext('Create new mark-down file…')
      }
    }
  }]
}

For the side bar have a look at the files app, defaults.js & fileSideBars

API driven development

Until now we only had a look at the ui and how the extensions are managed on the cli. But how do apps actually talk to the server?

Short answer: any way you like

Long answer: micro and ocis-hello follow a protocol driven development:

  • specify the API using protobuf

  • generate client and server code

  • evolve based on the protocol

  • CS3 api uses protobuf as well and uses GRPC

  • ocis uses go-micro, which provides http and grpc gateways

  • the gateways and protocols are optional

  • owncloud and kopano are looking into a MS graph like api to handle ownCloud Web requests.

    • they might be about user, contacts, calendars … which is covered by the graph api
    • we want to integrate with eg. kopano and provide a common api (file sync and share is covered as well)
  • as an example for protobuf take a look at ocis-hello