Skip to content

Commit

Permalink
Minor doc fixes & improvements (#1340)
Browse files Browse the repository at this point in the history
  • Loading branch information
owi92 authored Feb 11, 2025
2 parents 9cf8168 + cf673e4 commit 598fc0b
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 5 deletions.
2 changes: 1 addition & 1 deletion backend/src/logger.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/dev/create-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 1 addition & 0 deletions docs/docs/setup/ansible-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/setup/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
5 changes: 2 additions & 3 deletions docs/docs/setup/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand Down

0 comments on commit 598fc0b

Please sign in to comment.