diff --git a/modules/owncloud_web/images/web-with-oc10/application-switcher-oc10.jpg b/modules/owncloud_web/images/web-with-oc10/application-switcher-oc10.jpg deleted file mode 100644 index f1abf6b..0000000 Binary files a/modules/owncloud_web/images/web-with-oc10/application-switcher-oc10.jpg and /dev/null differ diff --git a/modules/owncloud_web/pages/index.adoc b/modules/owncloud_web/pages/index.adoc index 8893389..f747fec 100644 --- a/modules/owncloud_web/pages/index.adoc +++ b/modules/owncloud_web/pages/index.adoc @@ -6,11 +6,9 @@ {description} -If you are still running ownCloud Classic, consider installing the {oc-marketplace-url}/apps/web[Web] app, which provides the new look and feel plus some additional features, but not everything ownCloud Web has to offer when used with Infinite Scale. For a quick introduction about what's new or different, check out the section xref:web_with_oc_server.adoc[ownCloud Web on ownCloud Classic]. - == Changes -For readers already familiar with ownCloud Classic and its standard web interface, the big differences in the new ownCloud Web on Infinite Scale are: +For readers already familiar with ownCloud Classic and its standard web interface, the big differences in the new ownCloud Web are: * Spaces: Spaces are special folders for teams. They are organized by the team members themselves so that admins don't need to manage them. Even if members leave, the files stay in place so your team can keep on working. * Simplified links: Just select if only invited people or everyone can access a link. In consequence, we no longer distinguish between private and public links. diff --git a/modules/owncloud_web/pages/web_for_users.adoc b/modules/owncloud_web/pages/web_for_users.adoc index 824f476..2205d4a 100644 --- a/modules/owncloud_web/pages/web_for_users.adoc +++ b/modules/owncloud_web/pages/web_for_users.adoc @@ -12,8 +12,6 @@ If this file gets relocated or renamed, a page alias must be added to make it av {description} -If you have been using ownCloud before but with the ownCloud Classic user interface, you may want to check out section xref:web_with_oc_server.adoc[ownCloud Web with ownCloud Classic] to get an overview of the main differences. - The following description assumes you're new to ownCloud. image::web-for-users/personal-space.png[Start Page,width=500] diff --git a/modules/owncloud_web/pages/web_with_oc_server.adoc b/modules/owncloud_web/pages/web_with_oc_server.adoc deleted file mode 100644 index 243a52e..0000000 --- a/modules/owncloud_web/pages/web_with_oc_server.adoc +++ /dev/null @@ -1,211 +0,0 @@ -= ownCloud Web on ownCloud Classic -:toc: right -:description: ownCloud web is available for ownCloud Classic as an app. To ease the transition from ownCloud Classic to Infinite Scale, we recommend deploying the new user interface. - -:onlyoffice-owncloud-web-url: https://github.com/ONLYOFFICE/onlyoffice-owncloud-web - -== Introduction - -{description} It can be downloaded from the marketplace as https://marketplace.owncloud.com/apps/web[Web app]. - -ownCloud users will benefit from the following additions and improvements: - -=== Main Navigation on Top - -* The most significant change to the basic layout is that the top bar is now instantly recognizable as the main navigation bar. Here you find the app switcher, global search, dark mode and new account menu. - -* On the left, you will find the ’app switcher’, which allows you to switch between different applications in the ownCloud interface, such as files and chat tools. It will also be possible to switch to more apps in the future. - -* In the middle of the top bar is the search bar. The new global search is prepared for searching not only for files, but also for content in other apps like chat messages. - -* On the right side, you can now turn on the new dark mode for ownCloud – an option that many users asked for. - -* On the far right of the top bar is the redesigned account menu, which now also shows the amount of storage space still available (personal quota). - -=== Collapsible Left Sidebar and New Icons - -The application-specific navigation is located in the left sidebar as before. The sidebar has been made collapsible by request of many users, so that the area of the application main window can be maximized. - -For all icons in the sidebar and the main window, we use a new unified design set. In addition, the filetype icons are color-coded for example, PDF files are red, spreadsheets are green and zip archives are yellow. - -=== Context Menu Accessible via Right-Click - -The context menu with the most important app functions can now be opened via right click, a usability feature welcomed by many test users. This allows users to perform typical actions even faster, for example, downloading documents or opening documents in the Collabora and OnlyOffice office apps. - -=== Easier Document Sharing - -The new Web UI makes sharing content easier. Quick Action icons enable you to open files and folders with a single click. It’s just as easy to invite users as viewers or editors to view or collaborate on documents. - -=== Improved Accessibility - -We have added new accessibility features to the ownCloud user interface. The new Web UI can be controlled completely via keyboard, offers improved color contrast for better readability, and supports navigation and operation via screen reader. We are thus meeting the requirements of many users in the public sector, such as educational and government institutions. - -In addition to these new features, we also optimized a few other features in the frontend design of ownCloud. These include, among others, the rounded windows and the “shimmer effect” while the data of a directory is loaded from the server. - -== Deploying ownCloud Web - -ownCloud Web can be deployed as an app. Download it from the {oc-marketplace-url}/web[Marketplace] and run the command: - -[source,bash,subs="attributes+"] ----- -{occ-command-example-prefix} market:install web ----- -Alternatively, log in to the server as admin and install the Web app via the Marketplace app. - -=== Configure Authentication - -ownCloud Web works with OAuth2 and OpenID Connect. - -If you're using OpenID Connect, add ownCloud Web as a new client to your identity provider. - -If you prefer to use {oc-marketplace-url}/oauth2[OAuth2], log in as admin, go to the `User Authentication` settings, add ownCloud Web as a new client and provide the redirect URL: `https:///index.php/apps/web/oidc-callback.html`. - -=== Server Configuration - -A few configuration steps are necessary on the ownCloud Classic server: - -. Set the ownCloud Web address so it gets displayed in the app switcher by adding the following line to the `config/config.php` file: -+ -[source,plaintext] ----- -'web.baseUrl' => 'https:///index.php/apps/web', ----- - -. Configure link routing. Public and private links can either be provided by the regular web interface (default) or by the new ownCloud Web app. If you set the `web.rewriteLinks` option in `config/config.php` to `true`, all links will be redirected to the new ownCloud Web: -+ -[source,plaintext] ----- -'web.rewriteLinks' => true, ----- - -. Optionally make ownCloud Web the default interface users see after they log in to ownCloud. By default, the regular web interface will be used. To make ownCloud Web the default, add the following line to the `config/config.php` file: -+ -[source,plaintext] ----- -'defaultapp' => 'web', ----- - -NOTE: While it is possible to make ownCloud Web the default interface, the decision should be carefully evaluated. Features are still being added to ownCloud Web and users might need to use the regular web interface for certain tasks. - -include::partial$/web-configuration.adoc[] - -=== Integrate Traditional ownCloud Classic Features in ownCloud Web - -ownCloud features that are not deeply integrated in the regular web interface can be added to the app switcher and to the user menu. - -NOTE: All apps that are listed in the ownCloud app switcher of the regular web interface will be added as links to the app switcher of the new ownCloud Web automatically. All those links will open in a new browser tab on click. - -To add new elements, open the `config.json` file in an editor, go to the `applications` section and add entries like the following example: - -[source,plaintext] ----- - { - "title": { - "en": "Custom Groups", - "de": "Benutzerdefinierte Gruppen" - }, - "icon": "settings-4", - "url": "https:///settings/personal?sectionid=customgroups" - } ----- - -TIP: This method can also be used to link external sites like help pages. Apps and links will be opened in a new browser tab. - -Entries for the user menu look like this: - -[source,plaintext] ----- - { - "icon": "settings-4", - "menu": "user", - "target": "_self", - "title": { - "de": "Hilfe", - "en": "Help" - }, - "url": "https://help-link.example" - } ----- - -TIP: This will add a link to the specified URL in the user menu. The link will open in the same tab. If you want it to open in a new tab, remove the line "target": "_self",. - -=== ONLYOFFICE Integration - -For ONLYOFFICE there is a {onlyoffice-owncloud-web-url}[native integration] available for ownCloud Web when it is used with an ownCloud Classic server. It fully integrates the ONLYOFFICE document editors and allows users to create and open documents directly in ownCloud Web. - -To use ONLYOFFICE in ownCloud Web, you need: - -* ownCloud Classic >= 10.8 -* ownCloud Web >= 4.0.0 -* {oc-marketplace-url}/onlyoffice[ONLYOFFICE connector] >= 7.1.1 - -Make sure that ONLYOFFICE works as expected in the regular UI then add the following to the `config.json` file to make it available in ownCloud Web: - -[source,plaintext] ----- -"external_apps": [ - { - "id": "onlyoffice", - "path": "https:///apps/onlyoffice/js/web/onlyoffice.js" - } -] ----- - -NOTE: Adjust the URL in the example according to your setup. - -=== Collabora Online Integration - -There is a native Collabora Online integration available for ownCloud Web when it is used with an ownCloud Classic server. It fully integrates the Collabora Online document editors and allows users to create and open documents directly in ownCloud Web. - -Requirements: - -* ownCloud server >= 10.8 -* ownCloud Web >= 4.0.0 -* {oc-marketplace-url}/richdocuments[Collabora Online] app >= 2.7.0 - -Make sure that Collabora Online works as expected in the regular UI, then add the following to `config.json` to make it available in ownCloud Web: - -[source,plaintext] ----- -"external_apps": [ - { - "id": "richdocuments", - "path": "https:///apps/richdocuments/js/richdocuments.js" - } -] ----- - -NOTE: Adjust the URL to match your setup. -NOTE: richdocuments >= 3.9.0 requires web >= 7.0.0. (The configuration is silently ignored in web <= 6.0.0.) - -=== Configuring the Preview App - -In case there are additional preview providers configured in the backend, there is no mechanism to announce those to the Preview app in ownCloud Web. However, you can add the additional supported mimeTypes to the Preview app by following these steps: - -. Remove the "preview" string from the "apps" section in your `config.json` file. -. Add the following config to your config.json file: - -[source,plaintext] ----- -"external_apps": [ - { - "id": "preview", - "path": "web-app-preview", - "config": { - "mimeTypes": ["image/tiff", "image/webp"] - } - } - ], ----- - -If you already have an "external_apps" section, just add the Preview app to the list. Adjust the "mimeTypes" list to match your additional preview providers. - -See xref:{latest-server-version}@server:admin_manual:configuration/files/previews_configuration.adoc#managing-your-preview-settings[Managing Your Preview Settings] for advice on how to add preview providers to the backend. - -NOTE: The Preview app needs to be moved from the apps section to the external_apps section because only external apps support additional configuration. There are plans to change the configuration of apps to give you a coherent admin experience in that regard. - -=== Accessing ownCloud Web - -After following all the steps, you should see a new entry in the application switcher called `New Design` which takes you to ownCloud Web. - -image::web-with-oc10/application-switcher-oc10.jpg[Application Switcher] diff --git a/modules/owncloud_web/partials/nav.adoc b/modules/owncloud_web/partials/nav.adoc index bfa1b2c..c5d497a 100644 --- a/modules/owncloud_web/partials/nav.adoc +++ b/modules/owncloud_web/partials/nav.adoc @@ -2,6 +2,5 @@ * ownCloud Web ** xref:owncloud_web:index.adoc[Introduction] ** xref:owncloud_web:requirements.adoc[Requirements] -** xref:owncloud_web:web_with_oc_server.adoc[ownCloud Web on ownCloud Classic] ** xref:owncloud_web:web_for_users.adoc[ownCloud Web for Users] ** xref:owncloud_web:web_for_admins.adoc[ownCloud Web for Admins] diff --git a/modules/owncloud_web/partials/web-configuration.adoc b/modules/owncloud_web/partials/web-configuration.adoc deleted file mode 100644 index 92793b0..0000000 --- a/modules/owncloud_web/partials/web-configuration.adoc +++ /dev/null @@ -1,88 +0,0 @@ -=== Configuring ownCloud Web - -There are a few configuration settings necessary for ownCloud Web to work correctly. Copy the example config below into the `config/config.json` file (create one if it does not exist) and adjust it for your environment: - -[source,plaintext] ----- -{ - "server" : "https://", - "theme": "https:///themes/owncloud/theme.json", - "auth": { - "clientId": "", - "url": "https:///index.php/apps/oauth2/api/v1/token", - "authUrl": "https:///index.php/apps/oauth2/authorize" - }, - "apps" : [ - "files", - "preview", - "draw-io" - ], - "applications" : [ - { - "title": { - "en": "Classic Design", - "de": "Klassisches Design", - "fr": "Design classique", - "zh_CN": "文件" - }, - "icon": "swap-box", - "url": "https:///index.php/apps/files" - }, - { - "icon": "settings-4", - "menu": "user", - "target": "_self", - "title": { - "de": "Einstellungen", - "en": "Settings" - }, - "url": "https:///index.php/settings/personal" - } - ] -} ----- - -If you use OpenID Connect instead of OAuth2, you need to replace the "auth" part with the following configuration: - -[source,plaintext] ----- - "openIdConnect": { - "metadata_url": "/.well-known/openid-configuration", - "authority": "", - "client_id": "", - "response_type": "code", - "scope": "openid profile email" - } ----- - -TIP: If any issues arise when trying to access the new design, a good start for debugging is to let a json validator check your `config.json` file. - -[caption=] -[cols="30%,70%",options="header",] -|=== -| Parameter -| Description - -| server -| ownCloud Classic address - -| theme -| theme to be used in ownCloud Web pointing to a json file in the themes folder - -| auth.clientId -| Client ID received when ownCloud Web was added in the `User Authentication` section by the admin - -| apps -| List of internal extensions to load - -| applications -| Additional apps and links to be displayed in the application switcher or in the user menu - -| applications[0].title -| Title visible in the application switcher or user menu, localizable - -| applications[1].menu -| Use `user` if the menu item should be displayed in the user menu (defaults to app switcher). -|=== - -NOTE: Do not place the `config.json` file in the app folder. If you do, the integrity check of the app will fail and issue warnings.