ownCloud
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage
  1. ownCloud
  2. /
  3. Clients
  4. /
  5. ownCloud Web
  6. /
  7. Getting Started
Edit page

Getting Started

Installation

Docker

Make sure to have Docker, Docker-Compose, Node.js and Yarn installed.

This setup currently doesn’t work on Windows out of the box.

Workaround One of our contributors has opened a PR to a dependency that prevents us from successfully bundling the frontend. Feel free to check out [his changes](https://github.com/egoist/rollup-plugin-postcss/pull/384) and build them locally if you absolutely want to work on Windows.

After cloning the source code, install the dependencies via yarn install and bundle the frontend code by running yarn build:w.

Then, you can start the backends by running docker-compose up oc10 ocis and access them via https://host.docker.internal:9200 (oCIS) and http://host.docker.internal:8080 (OC10). If you’re not using Docker Desktop, you might have to modify your /etc/hosts and add 172.17.0.1 docker.host.internal to make the host.docker.internal links work.

The bundled frontend code automatically gets mounted into the Docker containers, recompiles on changes and you can log in using the demo user (admin/admin) and take a look around!

Source code

The source code is hosted at https://github.com/owncloud/web. Please refer to the build documentation for Web.

Configuration

Depending on the backend you are using, there are sample config files provided in the config folder of the ownCloud Web git repository. See below for available backends. Also, find some of the configuration details below.

Options

  • options.homeFolder You can specify a folder that is used when the user navigates home. Navigating home gets triggered by clicking on the All files menu item. The user will not be jailed in that directory. It simply serves as a default location. You can either provide a static location, or you can use variables of the user object to come up with a user specific home path. This uses twig template variable style and allows you to pick a value or a substring of a value of the authenticated user. Examples are /Shares, /{{.Id}} and /{{substr 0 3 .Id}}/{{.Id}.
  • options.disablePreviews Set this option to true to disable previews in all the different file listing views. The only list view that is not affected by this is the trash bin, as that doesn’t allow showing previews at all.
  • options.previewFileExtensions Specifies which filetypes will be previewed in the ui. For example to only preview jpg and txt files set this option to ["jpg", "txt"].
  • options.disableFeedbackLink Set this option to true to disable the feedback link in the topbar. Keeping it enabled (value false or absence of the option) allows ownCloud to get feedback from your user base through a dedicated survey website.
  • options.feedbackLink This accepts an object with the following optional fields to customize the feedback link in the topbar:
    • options.feedbackLink.href Set a different target URL for the feedback link. Make sure to prepend it with http(s)://. Defaults to https://owncloud.com/web-design-feedback.
    • options.feedbackLink.ariaLabel Since the link only has an icon, you can set an e.g. screen reader accessible label. Defaults to ownCloud feedback survey.
    • options.feedbackLink.description Provide any description you want to see as tooltip and as accessible description. Defaults to Provide your feedback: We'd like to improve the web design and would be happy to hear your feedback. Thank you! Your ownCloud team.
  • options.sharingRecipientsPerPage Sets the amount of users shown as recipients in the dropdown when sharing resources. Default amount is 200.
  • options.sidebar.shares.showAllOnLoad Sets the list of (link) shares list in the sidebar to be initially expanded (default is a collapsed state, only showing the first three shares).
  • options.runningOnEos Set this option to true if running on an EOS storage backend to enable its specific features. Defaults to false.
  • options.cernFeatures Enabling this will activate CERN-specific features. Defaults to false.

Sentry

Web supports Sentry to provide monitoring and error tracking. To enable sending data to a Sentry instance, you can use the following configuration keys:

  • sentry.dsn Should contain the DSN for your sentry project.
  • sentry.environment: Lets you specify the enviroment to use in Sentry. Defaults to production.

Any other key under sentry will be forwarded to the Sentry initialization. You can find out more settings in the Sentry docs.

If you are using an old version of Sentry (9 and before), you might want to add the setting sentry.autoSessionTracking: false to avoid errors related to breaking changes introduced in the integration libraries.

Setting up backend and running

Web can run against either ownCloud 10 as backend or oCIS. Depending which one you chose, please check the matching section:

Running