Prepare content update for 7.2

antora.yml

@@ -28,30 +28,29 @@ asciidoc:
     # note that service_url_component is used for services ONLY
     # service_url_component will be used to assemble the url for services to include content (tables)
     # sourced from the ocis repo.
-    # 'docs' for the next branch or 'docs-stable-7.1' for a production branch
+    # 'docs' for the next branch or 'docs-stable-7.2' for a production branch
     service_url_component: 'docs'
 
     # defines the url path component when accessing the ocis repo for versioned data includes or examples
-    # 'master' for the next branch or 'stable-7.1' for a production branch
+    # 'master' for the next branch or 'stable-7.2' for a production branch
+    # example: {compose_url}{ocis_repo_url_component}{compose_final_path}
     ocis_repo_url_component: 'master'
 
+    # this always points to the latest stable branch such as 'stable-7.2'
+    # this branch also includes patches if any
+    # used for links where you would else download from master but the content better comes from stable
+    ocis_repo_url_stable: 'stable-7.2'
+
     # service_tab_text will be used as tab text shown for the tables in services only
     # note when literally changing the word 'master' to something else, you also must adapt 'env-and-yaml.adoc'.
     # this does not apply to branched releases using semver, only to the master branch! 
-    # 'master' for the next branch or '7.1.0' for a production branch including patch releases like `7.1.1'
+    # 'master' for the next branch or '7.2.0' for a production branch including patch releases like `7.2.1'
     service_tab_text: 'master'
 
-    # the compose_url_component is used to assemble the url (tag) accessing source files from the ocis repo
-    # 'master' for the next branch or 'v7.1.0' for a production branch
-    # note the v ! as it is tagged for anything else than master !!
-    # only use values that are tagged in the ocis repo.
-    # example: {compose_url}{compose_url_component}{compose_final_path}
-    compose_url_component: 'master'
-
     # this is the first part of the name for envvars between major versions that will be added or removed
     # example for full name: 7.0.0-7.1.0-added.adoc or 7.0.0-7.1.0-removed.adoc
     # note that the name must be exactly how it is defined in the ocis repo to access the source files!
-    env_var_delta_name: '7.0.0-7.1.0'
+    env_var_delta_name: '7.1.0-7.2.0'
 
     # set attributes defining path components which will be assembled in the document
     compose_url: 'https://github.com/owncloud/ocis/tree/'

false-positives.txt

@@ -0,0 +1,14 @@
+# placeholder for false-positives for the find-orphaned-files extension
+# this will get updated in another PR
+# do not delete this file but update/remove lines only
+
+# used via: xref:{s-path}/services_rules.adoc
+modules/ROOT/pages/deployment/services/s-list/services_rules.adoc
+
+# xref:{kb_path}/fail2ban-protect-login.adoc
+modules/ROOT/pages/additional-information/kb-documents/fail2ban-protect-login.adoc
+
+# source images we want to keep for further development
+modules/ROOT/images/depl-examples/ubuntu-compose/ubuntu-hetzner-access.drawio.svg
+modules/ROOT/images/depl-examples/ubuntu-compose/ubuntu-prod-install.drawio.svg
+modules/ROOT/images/depl-examples/ubuntu-compose/ubuntu-server-access.drawio.svg

modules/ROOT/pages/deployment/services/env-var-changes.adoc

@@ -1,9 +1,14 @@
 # Changed Environment Variables in Versions
 :toc: right
-:description: This page contains tables with added and removed environment variables between Infinite Scale version 7.0.0 and 7.1.0.
+:description: This page contains tables with added and removed environment variables between Infinite Scale version 7.1.0 and 7.2.0.
 
 :source_path: {ocis_services_raw_url}{service_url_component}{ocis_services_final_path}adoc/env-var-deltas/
-// https://raw.githubusercontent.com/owncloud/ocis/docs-stable-7.0/services/_includes/adoc/env-var-deltas/
+////
+ocis_services_raw_url:    https://raw.githubusercontent.com/owncloud/ocis/
+service_url_component:    docs || docs-stable-7.2
+ocis_services_final_path: /services/_includes/
+env_var_delta_name:       7.1.0-7.2.0
+////
 
 == Introduction
 

modules/ROOT/pages/deployment/services/s-list/policies.adoc

@@ -4,6 +4,8 @@
 
 :service_name: policies
 
+include::partial$multi-location/compose-version.adoc[]
+
 == Introduction
 
 {description} 
@@ -164,9 +166,9 @@ The policies service contains a set of preconfigured example policies. See the d
 {service_tab_text}::
 +
 --
-{compose_url}{compose_url_component}{compose_final_path}[Rego policies deployment examples directory,window=_blank]
+{compose_url}{compose_version}{compose_final_path}[Rego policies deployment example directory,window=_blank]
 
-Using git version name: `{compose_url_component}`
+Using git branch name: `{compose_version}`, to point to the latest stable version that also includes patches
 --
 ====
 

modules/ROOT/pages/deployment/webui/webui-theming.adoc

@@ -8,6 +8,8 @@
 :design-tokens-url: https://owncloud.design/#/Design%20Tokens
 :gh-webui-url: https://github.com/owncloud/web/issues/new
 
+include::partial$multi-location/compose-version.adoc[]
+
 == Introduction
 
 {description}  As an organization or company you may be interested in theming the ownCloud Web user interface with your brand and slogan and playful individuals may simply enjoy the fun of decorating ownCloud Web the way they like.
@@ -39,8 +41,8 @@ Some theme keys are mandatory, like the `common.shareRoles` settings. Such manda
 
 == Configuring a Theme
 
-.Sourced from https://github.com/owncloud/ocis/blob/{ocis_repo_url_component}{web_assets_path}theme.json[GitHub, _window=blank]
+.Sourced from https://github.com/owncloud/ocis/blob/{compose_version}{web_assets_path}theme.json[GitHub, _window=blank]
 [source,json]
 ----
-include::{ocis_services_raw_url}{ocis_repo_url_component}{web_assets_path}theme.json[]
+include::{ocis_services_raw_url}{compose_version}{web_assets_path}theme.json[]
 ----

modules/ROOT/pages/deployment/wopi/wopi.adoc

@@ -7,6 +7,8 @@
 :wopi-wiki-url: https://en.wikipedia.org/wiki/Web_Application_Open_Platform_Interface
 :wopi-ms-url: https://learn.microsoft.com/en-us/openspecs/office_protocols/ms-wopi/6a8bb410-68ad-47e4-9dc3-6cf29c6b046b
 
+include::partial$multi-location/compose-version.adoc[]
+
 == Introduction
 
 {description} For more details on possible configuration values see the xref:conf-examples/office/office-integration.adoc[Office Integration] document at the configuration examples. More information about the WOPI protocol can be found on {wopi-wiki-url}[Wikipedia,window=_blank] or {wopi-ms-url}[Microsoft,window=_blank].
@@ -73,9 +75,9 @@ image::deployment/wopi/wopi-overview.svg[WOPI Overview Diagram,width=500]
 {service_tab_text}::
 +
 --
-{compose_url}{compose_url_component}{compose_final_path}/{ocis_wopi}[Docker compose `ocis_full` deployment examples directory,window=_blank]
+{compose_url}{compose_version}{compose_final_path}/{ocis_wopi}[Docker compose `ocis_full` deployment example directory,window=_blank]
 
-Using git version name: `{compose_url_component}`
+Using git branch name: `{compose_version}`, to point to the latest stable version that also includes patches
 --
 ====
 

modules/ROOT/pages/index.adoc

@@ -8,6 +8,8 @@
 :ocis_youtube_long_url: https://www.youtube.com/watch?v=C4a4q9IGyFQ&list=PLXpTv1ixYy3-b5LScHyYqMNwEsZYgejdX&index=16
 :ocis_youtube_short_url: C4a4q9IGyFQ
 
+include::partial$multi-location/compose-version.adoc[]
+
 == Introduction
 
 {description}
@@ -80,4 +82,4 @@ IMPORTANT: Rolling releases are published in a cycle of 3 weeks. Due to this rel
 
 == End-User License Agreement (EULA)
 
-ownCloud provides an EULA to clarify, among various topics, who can use this software and which conditions apply to the groups of users defined. See the actual {compose_raw_url}{compose_url_component}/assets/End-User-License-Agreement-for-ownCloud-Infinite-Scale.pdf[EULA] for details.
+ownCloud provides an EULA to clarify, among various topics, who can use this software and which conditions apply to the groups of users defined. See the actual {compose_raw_url}{compose_version}/assets/End-User-License-Agreement-for-ownCloud-Infinite-Scale.pdf[EULA] for details.

modules/ROOT/pages/maintenance/commands/changed-cli.adoc

@@ -1,6 +1,6 @@
 = Changed or Added CLI Commands
 :toc: right
-:description: This page contains a list with added, changed or removed CLI commands between Infinite Scale version 7.0.0 and 7.1.0.
+:description: This page contains a list with added, changed or removed CLI commands between Infinite Scale version 7.1.0 and 7.2.0.
 
 == Introduction
 
@@ -10,5 +10,5 @@
 
 See the link for a detailed description of the respective CLI command if available.
 
-* xref:maintenance/commands/commands.adoc#sending-grouped-emails[Sending Grouped Emails] +
-The `ocis auth-app create` command allows creating tokens to authenticate 3rd party access.
+* xref:maintenance/commands/commands.adoc#manage-expired-or-stale-uploads[Manage Expired or Stale Uploads] +
+The `ocis storage-users uploads delete-stale-nodes` command deletes all nodes that are in processing state and not referenced by an upload session.

modules/ROOT/pages/migration/upgrading-ocis.adoc

@@ -19,6 +19,20 @@ IMPORTANT: When upgrading from an older release to the desired one, *ALL* upgrad
 
 IMPORTANT: When upgrading from an older release to the desired one, mandatory configuration settings may have been added or removed. To see the changes required, you can run `ocis init --diff` after upgrading but before finally starting. For more details, see the xref:deployment/general/ocis-init.adoc[ocis init command] description.
 
+== Version 7.1.0 to 7.2.0
+
+=== Notable Changes Requiring Manual Intervention
+
+There are no notable changes requiring manual intervention in Infinite Scale 7.2
+
+=== Breaking Changes Requiring Manual Intervention
+
+There are no breaking changes in Infinite Scale 7.2
+
+=== Upgrade Steps
+
+For a detailed description of the steps to upgrade, see the xref:migration/upgrading_7.1.0_7.2.0.adoc[Upgrading from 7.1.0 to 7.2.0] documentation. Note that this document also contains references to added/changed/removed CLI commands and environment variables.
+
 == Version 7.0.0 to 7.1.0
 
 === Notable Changes Requiring Manual Intervention

modules/ROOT/pages/migration/upgrading_7.1.0_7.2.0.adoc

@@ -0,0 +1,95 @@
+= Upgrading from 7.1.0 to 7.2.0
+:toc: right
+:description: This document describes the necessary steps when upgrading Infinite Scale from release 7.1.0 to 7.2.0.
+
+:actual_seven_version: 7.2.0
+
+include::partial$multi-location/compose-version.adoc[]
+
+== Introduction
+
+{description}
+
+IMPORTANT: Read the important notes in the xref:migration/upgrading-ocis.adoc#introduction[Upgrading Infinite Scale] documentation before you start.
+
+IMPORTANT: Check below, if you are affected by breaking changes and prepare all steps mentioned before you start the upgrade.
+
+== Upgrade Steps
+
+. Download and install Infinite Scale +
+*Do not start it after downloading the image*!
+. Shut down the Infinite Scale instance
+. We strongly recommend doing a backup
+. Reconfigure the deployment
+. Manage Breaking Changes
+. Manage Added/Removed/Deprecated environment variables
+. Start Infinite Scale
+
+:sectnums:
+
+== Download and Install Infinite Scale
+
+Download and install Infinite Scale:
+
+* Issue the following command to download the new image:
++
+[source,bash,subs="attributes+"]
+----
+docker pull owncloud/ocis:{actual_seven_version}
+----
+
+== Shut Down the Infinite Scale Instance
+
+Depending how you deployed Infinite Scale, you need to shut it down differently.
+
+* *docker compose* +
+For deployments using `docker compose` do a graceful shutdown as described in xref:depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc#stop-the-deployment[Stop the Deployment].
+
+* *Any other image based deployment* +
+For any other image based deployment, shut down Infinite Scale according the vendors deployment description.
+
+== Backup of Infinite Scale
+
+See the xref:maintenance/b-r/backup_considerations.adoc[Backup Considerations] and the xref:maintenance/b-r/backup.adoc[Backup] documentation for more details.
+
+== Reconfigure the Deployment
+
+Reconfigure the deployment to use the new image:
+
+* For binary, nothing extra needs to be done
+
+* When using `docker compose`
+** Update _every_ compose file where the `ocis image` is referenced accordingly.
+** If you have used the deployment examples either for xref:depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc[Local Production Setup] or xref:depl-examples/ubuntu-compose/ubuntu-compose-hetzner.adoc[Deployment on Hetzner], read the *Updating and Upgrading* section of those pages carefully. 
+
+== Manage Breaking Changes
+
+* There are no breaking changes in Infinite Scale 7.2
+
+== Added-Removed-Deprecated Environment Variables
+
+* See the xref:deployment/services/env-var-changes.adoc[Changed Environment Variables in Versions] for more details.
+
+== Reconfigure web Office Document Deployments
+
+The following steps are based on the xref:depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc[Local Production Setup] deployment example. The steps are identical for the xref:depl-examples/ubuntu-compose/ubuntu-compose-hetzner.adoc[Deployment on Hetzner].
+
+* Backup the the base folder containing the existing deployment example by renaming it. +
+You will need your configuration details with the new example.
+
+* Follow the xref:depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc#download-and-transfer-the-example[Download and Transfer Example] to get the new deployment and extract it as described in the following section of the guide.
+
+* Reconfigure the new `.env` file based on settings made in the `.env` file of the backup. +
+Note that the `WOPISERVER_DOMAIN` is no longer required since all collaboration traffic is now handled via the internal Docker network. While it does no harm if the DNS configuration and certificate continues to exist, it should be removed for consistency reasons.
+
+== Start Infinite Scale
+
+When you have finished upgrading, you now can start Infinite Scale as usual.
+
+For any deployment used, you now can delete/remove old binaries or images/containers.
+
+:sectnums!:
+
+== Changed or Added CLI Commands
+
+See the xref:maintenance/commands/changed-cli.adoc[Changed or Added CLI Commands] document for details.

modules/ROOT/partials/depl-examples/ubuntu-compose/shared-setup.adoc

@@ -250,7 +250,7 @@ NOTE: The client that downloads the example is not the server that you upload to
 
 NOTE: The client from which you download the example via a browser and upload it using `scp` must have access to the server and have the `scp` application installed.
 
-To download and extract the necessary deployment example footnote:[Derived from the {compose_url}{compose_version}{compose_final_path}/{ocis_wopi}/[{ocis_wopi}, window=_blank] developer example], *open a browser* and enter the following URL:
+To download and extract the necessary deployment example footnote:[Derived from the {compose_url}{compose_version}{compose_final_path}/{ocis_wopi}/[{ocis_wopi}, window=_blank] developer example], *open a browser* and enter the following URL. Note that this link also contains patches for release: `{ocis-actual-version}`.
 
 //[source,url,subs="attributes+,+macros"]
 //----