Build of develop from Fri Dec 6 13:04:47 UTC 2024

404.html

@@ -6,7 +6,7 @@
     <script type="text/javascript">
       // Redirect if URL links to stable
       if (window.location.pathname.startsWith('/stable/')) {
-        window.location.replace(window.location.pathname.replace(/^\/stable\//, '/r/16.x/'));
+        window.location.replace(window.location.pathname.replace(/^\/stable\//, '/r/17.x/'));
       }
     </script>
   </head>

develop/admin/index.html

@@ -764,5 +764,5 @@ <h2 id="release-documentation">Release Documentation</h2>
 </html>
 <!--
 MkDocs version : 1.6.1
-Build Date UTC : 2024-12-03 20:38:30.949176+00:00
+Build Date UTC : 2024-12-06 13:04:32.064042+00:00
 -->

develop/admin/releasenotes/index.html

@@ -34,6 +34,7 @@
 
         var pageToc = [
           {title: "Opencast 17: Release Notes", url: "#_top", children: [
+              {title: "Opencast 17.0", url: "#opencast-170" },
               {title: "Release Schedule", url: "#release-schedule" },
               {title: "Release Managers", url: "#release-managers" },
           ]},
@@ -87,6 +88,56 @@
 
 
     <h1 id="opencast-17-release-notes">Opencast 17: Release Notes</h1>
+<h2 id="opencast-170">Opencast 17.0</h2>
+<h3 id="features">Features</h3>
+<ul>
+<li>New roles were added with which a user can get access to an event without having to be added to the ACLs. For more
+  details see the relevant <a href="../configuration/episode-id-roles/">documentation</a>.
+  [<a href="https://github.com/opencast/opencast/pull/5056">#5056</a>]</li>
+<li>You can now generate captions with Whisper asynchronously. [<a href="https://github.com/opencast/opencast/pull/6247">#6247</a>]</li>
+<li>The Whisper.cpp integration now automatically re-encodes audio to a suitable format. It's
+  no longer necessary to include a separate encode operation for this in the workflow.
+  [<a href="https://github.com/opencast/opencast/pull/6248">#6248</a>]</li>
+<li>You can now provide terms of use to be presented to new users in the Admin UI. For configuration see
+  <a href="../configuration/admin-ui/terms.md">the respective docs</a>. [<a href="https://github.com/opencast/opencast/pull/6010">#6010</a>]</li>
+<li>There is a new UI for the documentation of our REST endpoints but since it currently has some issues, it's not turned
+  on by default. You can however already try it out. [<a href="https://github.com/opencast/opencast/pull/5668">#5668</a>]</li>
+<li>There is a new GraphQL API as an alternative to the existing REST API. Please be aware that this is not yet production
+  ready and may change without further notice. [<a href="https://github.com/opencast/opencast/pull/5766">#5766</a>]</li>
+<li>There is a new filter available in the Admin interface to show only events that are published or not published.
+  [<a href="https://github.com/opencast/opencast/pull/6023">#6023</a>]</li>
+<li>The integration of Tobira in the Admin interface was improved.
+  [<a href="https://github.com/opencast/opencast/pull/6091">#6091</a>]</li>
+<li>Paella Player 7 now also shows a preview image in portrait mode.
+  [<a href="https://github.com/opencast/opencast/pull/6052">#6052</a>]</li>
+</ul>
+<h3 id="breaking-changes">Breaking Changes</h3>
+<ul>
+<li><strong>The old Admin UI was removed completely and is no longer available.</strong>
+[<a href="https://github.com/opencast/opencast/pull/5965">#5965</a>]</li>
+<li>We changed the sorting of events and series in the new Admin interface to something more intuitive. This <strong>requires the
+  installation of the OpenSearch/Elasticsearch plugin</strong> <code>analysis-icu</code>. Check the <a href="../upgrade/">upgrade guide</a> for more
+  details. [<a href="https://github.com/opencast/opencast/pull/5413">#5413</a>]</li>
+<li>The required Java version is now 17. [<a href="https://github.com/opencast/opencast/pull/5763">#5763</a>]</li>
+<li>The Microsoft Azure transcription integration was completely rewritten. Gstreamer is no longer needed as a dependency.
+  Please consult the updated <a href="../configuration/transcription.configuration/microsoftazure/">documentation</a> to find out
+  how to change your configuration and workflows so they are compatible again.
+  [<a href="https://github.com/opencast/opencast/pull/5876">#5876</a>]</li>
+<li>ACL templates in <code>etc/acl/</code> must be provided in JSON format from now on. XACML files are no longer accepted.
+  [<a href="https://github.com/opencast/opencast/pull/6018">#6018</a>]</li>
+</ul>
+<h3 id="configuration-changes">Configuration Changes</h3>
+<ul>
+<li>We no longer use the prepared flavor in our workflows and the Editor configuration as it was no longer serving any
+  purpose and made updating subtitles from the Editor difficult. Instead, we now always use the source flavor.
+  [<a href="https://github.com/opencast/opencast/pull/5862">#5862</a>]</li>
+<li>Since we removed feeds in OC 16, we no longer generate feed previews in our workflows.
+  [<a href="https://github.com/opencast/opencast/pull/6087">#6087</a>]</li>
+<li>Waveform peaks are now more visible, but that behavior is configurable.
+  [<a href="https://github.com/opencast/opencast/pull/6028">#6028</a>]</li>
+</ul>
+<p>For more details, please take a look at the <a href="../changelog/">full changelog</a>. If you want to update Opencast from a
+previous version, you should also read the <a href="../upgrade/">upgrade guide</a>.</p>
 <h2 id="release-schedule">Release Schedule</h2>
 <table>
 <thead>

develop/admin/upgrade/index.html

@@ -34,6 +34,10 @@
 
         var pageToc = [
           {title: "Upgrading Opencast from 16.x to 17.x", url: "#_top", children: [
+              {title: "Elasticsearch/Opensearch Plugin Installation", url: "#elasticsearchopensearch-plugin-installation" },
+              {title: "Configuration Changes", url: "#configuration-changes" },
+              {title: "Index Rebuild", url: "#index-rebuild" },
+              {title: "Uninstall Gstreamer", url: "#uninstall-gstreamer" },
           ]},
         ];
 
@@ -85,7 +89,58 @@
 
 
     <h1 id="upgrading-opencast-from-16x-to-17x">Upgrading Opencast from 16.x to 17.x</h1>
-<p>TBA.</p>
+<p>This guide describes how to upgrade Opencast 16.x to 17.x.
+In case you need to upgrade older versions of Opencast, please refer to the documentation of
+<a href="https://docs.opencast.org">those versions</a> first.</p>
+<ol>
+<li>Read the <a href="../releasenotes/">release notes</a></li>
+<li>Stop your current Opencast instance</li>
+<li>Install the required <a href="#elasticsearchopensearch-plugin-installation">Elasticsearch/Opensearch plugin</a></li>
+<li>Replace Opencast with the new version</li>
+<li>Review the <a href="#configuration-changes">configuration changes</a> and adjust your configuration accordingly</li>
+<li>Start Opencast</li>
+<li><a href="#index-rebuild">Rebuild the index</a></li>
+<li>Optional: <a href="#uninstall-gstreamer">Remove Gstreamer</a></li>
+</ol>
+<h2 id="elasticsearchopensearch-plugin-installation">Elasticsearch/Opensearch Plugin Installation</h2>
+<p>The <code>analysis-icu</code> plugin for OpenSearch is required for Opencast 17. To install the plugin, run either</p>
+<pre><code>bin/opensearch-plugin install analysis-icu
+</code></pre>
+<p>or</p>
+<pre><code>bin/elasticsearch-plugin install analysis-icu
+</code></pre>
+<p>on all nodes of your Elasticsearch/Opensearch cluster and restart each node.</p>
+<h2 id="configuration-changes">Configuration Changes</h2>
+<p>Check for changes in the configuration and apply those relevant to your setup to your files. You can use the following
+command to list all changes:</p>
+<pre><code>git diff origin/r/17.x origin/r/18.x -- etc/
+</code></pre>
+<p>The most important changes are:
+- The prepared flavor was removed from our workflows and the Editor configuration, the source flavor is now used instead.
+  If you have custom workflows, you only need to check default settings of EditorServiceImpl.cfg.
+  If you use the affected community workflows, ensure any custom workflows and integrations are still compatible.
+  [<a href="https://github.com/opencast/opencast/pull/5862">#5862</a>]
+- We no longer generate feed previews in our workflows. [<a href="https://github.com/opencast/opencast/pull/6087">#6087</a>]
+- ACL templates in <code>etc/acl/</code> must now be provided in JSON format.
+  [<a href="https://github.com/opencast/opencast/pull/6018">#6018</a>]
+- The Microsoft Azure transcription integration was completely rewritten, please check
+  <a href="../configuration/transcription.configuration/microsoftazure/">documentation</a> if you use it.
+  [<a href="https://github.com/opencast/opencast/pull/5876">#5876</a>]</p>
+<h2 id="index-rebuild">Index Rebuild</h2>
+<p>[<a href="https://github.com/opencast/opencast/pull/5413">#5413</a>] only requires an update of the index mappings, for which there
+are migration scripts in <code>docs/upgrade/16_to_17/</code>, but [<a href="https://github.com/opencast/opencast/pull/6023">#6023</a>]
+requires a full rebuild of the indexes that feed the Admin Interface and External API, so that is what's described here.</p>
+<p>You can do so by making a POST request to <code>/index/rebuild</code>, either like this</p>
+<pre><code>curl -i -u &lt;admin_user&gt;:&lt;password&gt; -s -X POST https://example.opencast.org/index/rebuild
+</code></pre>
+<p>or by opening the REST docs under the “?” symbol at the top right corner of the Admin Interface, going to the “Index
+Endpoint” section and using the testing form on <code>/rebuild</code> to issue a POST request.</p>
+<p>In both cases you should get a 200 HTTP status. The log or the Admin Interface will tell you when the rebuild is
+completed.</p>
+<h2 id="uninstall-gstreamer">Uninstall Gstreamer</h2>
+<p>The Microsoft Azure transcription integration was completely rewritten by
+[<a href="https://github.com/opencast/opencast/pull/5876">#5876</a>] and Gstreamer is no longer needed as a dependency.
+If you had it installed for this purpose, you can remove it now.</p>
 
   <br>
 

develop/commit

@@ -1,9 +1,5 @@
-commit 11fbdc7fdf88ae1726eb28f083b6b87459d8d139
-Author: Greg Logan <[email protected]>
-Date:   Tue Dec 3 14:37:41 2024 -0600
+commit be2500dc2d56882d42ada789aa05f320c33c6907
+Author: Katrin Ihler <[email protected]>
+Date:   Fri Dec 6 14:03:52 2024 +0100
 
-    Merge branch 't/proposal-mandatory-2fa' of ziegenberg/opencast into develop
-
-    Pull request #6325
-
-      Proposal: Require 2FA for all committers
+    Merge branch 'r/17.x' into develop

develop/developer/architecture/api/glossary/index.html

@@ -64,12 +64,12 @@
   <div class="row wm-article-nav-buttons" role="navigation" aria-label="navigation">
 
     <div class="wm-article-nav pull-right">
-      <a href="../../filesystem/" class="btn btn-xs btn-default pull-right">
+      <a href="../../graphql/" class="btn btn-xs btn-default pull-right">
         Next
         <i class="fa fa-chevron-right" aria-hidden="true"></i>
       </a>
-      <a href="../../filesystem/" class="btn btn-xs btn-link">
-        Filesystem
+      <a href="../../graphql/" class="btn btn-xs btn-link">
+        Introduction
       </a>
     </div>
 
@@ -116,12 +116,12 @@ <h3 id="spectator">Spectator</h3>
   <div class="row wm-article-nav-buttons" role="navigation" aria-label="navigation">
 
     <div class="wm-article-nav pull-right">
-      <a href="../../filesystem/" class="btn btn-xs btn-default pull-right">
+      <a href="../../graphql/" class="btn btn-xs btn-default pull-right">
         Next
         <i class="fa fa-chevron-right" aria-hidden="true"></i>
       </a>
-      <a href="../../filesystem/" class="btn btn-xs btn-link">
-        Filesystem
+      <a href="../../graphql/" class="btn btn-xs btn-link">
+        Introduction
       </a>
     </div>
 

develop/developer/architecture/filesystem/index.html

@@ -71,10 +71,10 @@
     </div>
 
     <div class="wm-article-nav">
-      <a href="../api/glossary/" class="btn btn-xs btn-default pull-left">
+      <a href="../graphql/" class="btn btn-xs btn-default pull-left">
         <i class="fa fa-chevron-left" aria-hidden="true"></i>
-        Previous</a><a href="../api/glossary/" class="btn btn-xs btn-link">
-        Glossary
+        Previous</a><a href="../graphql/" class="btn btn-xs btn-link">
+        Introduction
       </a>
     </div>
 
@@ -106,10 +106,10 @@ <h1 id="under-construction">Under Construction</h1>
     </div>
 
     <div class="wm-article-nav">
-      <a href="../api/glossary/" class="btn btn-xs btn-default pull-left">
+      <a href="../graphql/" class="btn btn-xs btn-default pull-left">
         <i class="fa fa-chevron-left" aria-hidden="true"></i>
-        Previous</a><a href="../api/glossary/" class="btn btn-xs btn-link">
-        Glossary
+        Previous</a><a href="../graphql/" class="btn btn-xs btn-link">
+        Introduction
       </a>
     </div>