Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New thumbnail generator for container deployments #1012

Merged
merged 3 commits into from
Oct 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion modules/ROOT/pages/depl-examples/bare-metal.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,12 @@ include::partial$multi-location/compose-version.adoc[]

{description}

This deployment example addresses a small production environment. For a minimal test and development environment, see the xref:depl-examples/minimal-bare-metal.adoc[Minimal Bare Metal Deployment]. The main differences between the setup described in this document and a minimal test environment is, the use of systemd, letsencrypt and a reverse proxy.
This deployment example addresses a small production environment without running online office applications etc. For a minimal test and development environment, see the xref:depl-examples/minimal-bare-metal.adoc[Minimal Bare Metal Deployment]. The main differences between the setup described in this document and a minimal test environment is, the use of systemd, letsencrypt and a reverse proxy. If you intend to run a complete setup using online office, full text search etc., see the *Ubuntu with Docker Compose* deployment examples.

Note that this guide expects that prerequisite of a computer with an installed Linux distribution of choice is met and required software other than Infinite Scale is installed and preconfigured. There is no detailed explanation but, where possible, links for more information are provided.

Note that there is a difference in internal thumbnail processing when using binary vs container deployments. For details see the xref:{s-path}/thumbnails.adoc#thumbnailing-performance[thumbnails] service.

This guide was tested on a Debian 11 (bullseye) host but should work on any other modern Linux system with systemd.

NOTE: The embedded IDM service provides a minimal LDAP service for Infinite Scale and does not replace a LDAP server. See the xref:{s-path}/idm.adoc[IDM Service Configuration] for details.
Expand Down
4 changes: 3 additions & 1 deletion modules/ROOT/pages/depl-examples/minimal-bare-metal.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,12 @@ include::partial$multi-location/compose-version.adoc[]

== Introduction

{description} It does not cover extended deployment tasks or how to manage trusted certificates etc. and is intended to get a first hands-on experience of the system.
{description} It does not cover extended deployment tasks, how to manage trusted certificates, run online office applications etc. and is intended to get a first hands-on experience of the system only.

For a small production environment using the binary installation approach, see the xref:depl-examples/bare-metal.adoc[Bare Metal Deployment with systemd]. The main differences between this setup and the small production environment using the binary installation is, in a nutshell, the use of systemd, LetsEncrypt and a reverse proxy.

Note that there is a difference in internal thumbnail processing when using binary vs container deployments. For details see the xref:{s-path}/thumbnails.adoc#thumbnailing-performance[thumbnails] service.

[IMPORTANT]
====
This minimal bare metal deployment makes the following assumptions:
Expand Down
8 changes: 6 additions & 2 deletions modules/ROOT/pages/deployment/services/s-list/thumbnails.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
= Thumbnails Service Configuration
:toc: right
:description: The thumbnails service provides methods to generate thumbnails for various files and resolutions based on requests.
:description: The thumbnails service provides methods to generate thumbnails for various files and resolutions based on requests,

:service_name: thumbnails

== Introduction

{description} It retrieves the sources at the location where the user files are stored and saves the thumbnails where system files are stored. Those locations have defaults but can be manually defined via environment variables.
{description} and is also responsible for presenting images, not only thumbnails to the client. It retrieves the sources at the location where the user files are stored and saves the thumbnails where system files are stored. Those locations have defaults but can be manually defined via environment variables.

Note for developers, more information is available with regards to querying thumbnails in the services section of the https://owncloud.dev/services/thumbnails/[Developer Documentation].

Expand All @@ -15,6 +15,10 @@ Note for developers, more information is available with regards to querying thum
* Thumbnails listens on port 9185 by default.
* The default location storing thumbnails is $OCIS_BASE_DATA_PATH/thumbnails

== Thumbnailing Performance

Thumbnail generation can consume considerably resources. For thumbnailing, two libraries are available. One library is embedded in the thumbnail service and statically linked where the other one is an external shared library, dynamically linked and must be available via the OS when accessing. The external shared library is not only much faster, but also provides more possible image types that can be converted. While the embedded library is only available with the binary deployment, the external library is built and preconfigured with the container deployment only. Note, if required, you can manually add the shared library to your OS and build Infinite Scale for the binary deployment on your own. To do so, see the https://owncloud.dev/services/thumbnails/[developer documentation, window=_blank] for more details.

== Configuration Hints

=== File Locations Overview
Expand Down