Minor doc fixes & improvements

backend/src/logger.rs

@@ -46,7 +46,7 @@ pub(crate) struct LogConfig {
     /// If this is set, log messages are also written to this file. The string
     /// `${cmd}` in this value is replaced by the subcommand name of the Tobira
     /// process, e.g. `serve`, `worker` or `other` (for less important
-    /// commands). Example: "/var/log/tobira-${job}.log".
+    /// commands). Example: "/var/log/tobira-${cmd}.log".
     pub(crate) file: Option<PathBuf>,
 
     /// If this is set to `false`, log messages are not written to stdout.

docs/docs/dev/create-release.md

@@ -38,6 +38,8 @@ Otherwise it might be confusing.
 
 - Once all that is done, publish the release.
 
+- Afterwards, consider updating [the example Ansible scripts](https://github.com/elan-ev/tobira-ansible-example) (release URL and config).
+
 
 ## Checklist for writing release notes
 

docs/docs/setup/ansible-example.md

@@ -5,6 +5,7 @@ sidebar_position: 6
 # Ansible example
 
 This document shows some Ansible scripts that can serve as a starting point to deploy Tobira.
+Also see [this repository](https://github.com/elan-ev/tobira-ansible-example) for a full playbook example.
 
 :::note
 These are **not** ready-to-use scripts. You have to adjust them according to your needs!

docs/docs/setup/config.toml

@@ -391,7 +391,7 @@
 # If this is set, log messages are also written to this file. The string
 # `${cmd}` in this value is replaced by the subcommand name of the Tobira
 # process, e.g. `serve`, `worker` or `other` (for less important
-# commands). Example: "/var/log/tobira-${job}.log".
+# commands). Example: "/var/log/tobira-${cmd}.log".
 #file =
 
 # If this is set to `false`, log messages are not written to stdout.

docs/docs/setup/requirements.md

@@ -18,7 +18,6 @@ To run, Tobira requires:
 
 These are technicalities that you likely don't need to care about if you have a dedicated and modern PostgreSQL for Tobira.
 
-- For PostgreSQL version 12 and older, you have to manually enable the `pgcrypto` and `hstore` extensions!
 - Over the lifetime of a Tobira installation the `current_schema()` must not change.
 - Tobira assumes exclusive control over the `current_schema()`.
   So don't let other applications use the same schema.
@@ -31,8 +30,8 @@ There are some requirements.
 
 - The Tobira Opencast module needs to be installed.
   This is included in Opencast starting with 12.3 (released 2022-09-21).
-  All Tobira releases specify which Opencast version they require.
-  If you are using an earlier Opencast, you have to manually include the module in the correct version.
+  Note that Tobira works with 12.3, but a some features (like subtitles) might not work on older versions.
+  Therefore, a new Opencast version is preferred.
 
 - No static file authorization.
   Tobira links to various assets (thumbnails, videos, ...) on Opencast's servers.