deblan-mirror/docker-collabora-online
1
0
Fork 0
mirror of https://github.com/tiredofit/docker-collabora-online.git synced 2024-05-17 21:46:34 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse source
This commit is contained in:
Dave Conroy 2021-05-02 16:47:14 -07:00
parent a31665985a
commit eac6096435
2 changed files with 111 additions and 58 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.github/workflows/main.yml vendored
View file

@ -1,7 +1,7 @@
### Application Level Image CI
### Dave Conroy <dave at tiredofit dot ca>
name: 'Build Images'
name: 'build'
on:
push:

167
README.md
View file

@ -1,77 +1,102 @@
# hub.docker.com/r/tiredofit/libreoffice-online
# github.com/tiredofit/docker-libreoffice-online
[![Docker Pulls](https://img.shields.io/docker/pulls/tiredofit/libreoffice-online.svg)](https://hub.docker.com/r/tiredofit/libreoffice-online)
[![Docker Stars](https://img.shields.io/docker/stars/tiredofit/libreoffice-online.svg)](https://hub.docker.com/r/tiredofit/libreoffice-online)
[![Docker Layers](https://images.microbadger.com/badges/image/tiredofit/libreoffice-online.svg)](https://microbadger.com/images/tiredofit/libreoffice-online)
[![GitHub release](https://img.shields.io/github/v/tag/tiredofit/docker-libreoffice-online?style=flat-square)](https://github.com/tiredofit/docker-libreoffice-online/releases/latest)
[![Build Status](https://img.shields.io/github/workflow/status/tiredofit/docker-libreoffice-online/build?style=flat-square)](https://github.com/tiredofit/docker-libreoffice-online/actions?query=workflow%3Abuild)
[![Docker Stars](https://img.shields.io/docker/stars/tiredofit/libreoffice-online.svg?style=flat-square&logo=docker)](https://hub.docker.com/r/tiredofit/libreoffice-online/)
[![Docker Pulls](https://img.shields.io/docker/pulls/tiredofit/libreoffice-online.svg?style=flat-square&logo=docker)](https://hub.docker.com/r/tiredofit/libreoffice-online/)
[![Become a sponsor](https://img.shields.io/badge/sponsor-tiredofit-181717.svg?logo=github&style=flat-square)](https://github.com/sponsors/tiredofit)
[![Paypal Donate](https://img.shields.io/badge/donate-paypal-00457c.svg?logo=paypal&style=flat-square)](https://www.paypal.me/tiredofit)
# Introduction
* * *
This will build a container for [LibreOffice Online](https://libreoffice.org/) for editing documents in a browser from supported applications
* This Container uses a [customized Debian Linux base](https://hub.docker.com/r/tiredofit/debian) which includes [s6 overlay](https://github.com/just-containers/s6-overlay) enabled for PID 1 Init capabilities, [zabbix-agent](https://zabbix.org) for individual container monitoring, Cron also installed along with other tools (bash,curl, less, logrotate, nano, vim) for easier management.
## About
This will build a Docker image for [LibreOffice Online](https://libreoffice.org/) for editing documents in a browser from supported applications.
* Configurable Concurrent User and Document Limit (set to generarous values by default)
* Custom Font Support
* Set features to support autogeneration of TLS certificates/activate reverse proxy support, others..
* Set features to support autogeneration of TLS certificates/activate reverse proxy support
* Zabbix Monitoring of Active Documents, Users, Memory Consumed
[Changelog](CHANGELOG.md)
# Authors
## Maintainer
- [Dave Conroy](https://github.com/tiredofit)
# Table of Contents
## Table of Contents
- [Introduction](#introduction)
- [Changelog](CHANGELOG.md)
- [Prerequisites](#prerequisites)
- [About](#about)
- [Maintainer](#maintainer)
- [Table of Contents](#table-of-contents)
- [Prerequisites and Assumptions](#prerequisites-and-assumptions)
- [Installation](#installation)
- [Quick Start](#quick-start)
- [Build from Source](#build-from-source)
- [Prebuilt Images](#prebuilt-images)
- [Multi Archictecture](#multi-archictecture)
- [Configuration](#configuration)
- [Database](#database)
- [Data Volumes](#data-volumes)
- [Environment Variables](#environmentvariables)
- [Quick Start](#quick-start)
- [Persistent Storage](#persistent-storage)
- [Environment Variables](#environment-variables)
- [Base Images used](#base-images-used)
- [General Usage](#general-usage)
- [Administration](#administration)
- [Logging](#logging)
- [TLS Settings](#tls-settings)
- [Performance and Limits](#performance-and-limits)
- [Cleanup](#cleanup)
- [Other Settings](#other-settings)
- [Adding Custom Fonts](#adding-custom-fonts)
- [Networking](#networking)
- [Maintenance](#maintenance)
- [Shell Access](#shell-access)
- [References](#references)
- [Support](#support)
- [Usage](#usage)
- [Bugfixes](#bugfixes)
- [Feature Requests](#feature-requests)
- [Updates](#updates)
- [License](#license)
# Prerequisites
## Prerequisites and Assumptions
* Assumes you are using some sort of SSL terminating reverse proxy such as:
* [Traefik](https://github.com/tiredofit/docker-traefik)
* [Nginx](https://github.com/jc21/nginx-proxy-manager)
* [Caddy](https://github.com/caddyserver/caddy)
This image assumes that you are using a reverse proxy such as [jwilder/nginx-proxy](https://github.com/jwilder/nginx-proxy) and optionally the [Let's Encrypt Proxy Companion @ https://github.com/JrCs/docker-letsencrypt-nginx-proxy-companion](https://github.com/JrCs/docker-letsencrypt-nginx-proxy-companion), or [Traefik](https://github.com/tiredofit/docker-traefik) in order to serve your pages. However, it will run just fine on it's own if you map appropriate ports.
## Installation
### Build from Source
- Clone this repository and build the image with `docker build <arguments> (imagename) .`
- If you decide to compile this, it will take quite a few hours even on the fastest computer due to the amount of data required to download to compile. At some stages this image will grow to 30GB before sheeding most of it for it's final size.
# Installation
Builds of the image are available on [Docker Hub](https://hub.docker.com/tiredofit/libreoffice-online) and is the
recommended method of installation.
If you decide to compile this, it will take quite a few hours even on the fastest computer due to the amount of data required to download to compile. At some stages this image will grow to 30GB large before sheeding most of it for it's final size.
### Prebuilt Images
Builds of the image are available on [Docker Hub](https://hub.docker.com/r/tiredofit/libreoffice-online) and is the recommended method of installation.
```bash
docker pull tiredofit/libreoffice-online
docker pull tiredofit/libreoffice-online:(imagetag)
```
The following image tags are available:
The following image tags are available along with their taged release based on what's written in the [Changelog](CHANGELOG.md):
* `latest` - See most recent versioned tag
* `2.1` - Collabora Office 6.4.x and Collabora Office Online 6.4.x
* `2.0` - Collabora Libreoffice 6.4-23 with Collabora Office Online 6.4.6-2
* `1.6` - Collabora Libreoffice 6.0.30 with Collabora Office Online 4.0.4-1
* `1.1` - Collabora Libreoffice 5.3.61 with Collabora Office Online 3.4.2.1
| LibreOffice version | LibreOffice Online version | Tag |
| ------------------- | -------------------------- | -------- |
| `6.4.x` | `6.4.x` | `latest` |
| `6.4.x` | `6.4.x` | `2.1` |
| `6.4.x` | `6.4.x` | `2.0` |
| `6.0.x` | `4.0.x` | `1.6` |
| `5.3.x` | `3.4.x` | 1.1 |
# Quick Start
#### Multi Archictecture
Images are built primarily for `amd64` architecture, and may also include builds for `arm/v6`, `arm/v7`, `arm64` and others. These variants are all unsupported. Consider [sponsoring](https://github.com/sponsors/tiredofit) my work so that I can work with various hardware. To see if this image supports multiple architecures, type `docker manifest (image):(tag)`
## Configuration
### Quick Start
* The quickest way to get started is using [docker-compose](https://docs.docker.com/compose/). See the examples folder for a working [docker-compose.yml](examples/docker-compose.yml) that can be modified for development or production use.
* Set various [environment variables](#environment-variables) to understand the capabilities of this image. A Sample `docker-compose.yml` is provided that will work right out of the box for most people without any fancy optimizations.
* Map [persistent storage](#data-volumes) for access to configuration and data files for backup.
# Configuration
### Persistent Storage
The following directories should be mapped for persistent storage in order to utilize the container effectively.
@ -86,18 +111,26 @@ The following directories should be mapped for persistent storage in order to ut
### Environment Variables
Along with the Environment Variables from the [Base image](https://hub.docker.com/r/tiredofit/debian), below is the complete list of available options that can be used to customize your installation.
#### Base Images used
### General Usage
| Parameter | Description | Default |
| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | ------------- |
| `SETUP_TYPE` | Automatically generate configuration with defaults. Set to `MANUAL` and map the configuration file to use your own | `AUTO` |
| `ALLOWED_HOSTS` | Set which domains which can access service Seperate Multiple with `,` - Example: `^(.*)\.example\.org` |
| `DICTIONARIES` | Spell Check Languages - Available `en_GB en_US` | `en_GB en_US` |
| `EXTRA_OPTIONS` | If you want to pass additional arguments upon startup, add it here |
| `INTERFACE` | Web interface type `classic` or `notebookbar` | `classic` |
| `WATERMARK_OPACITY | Watermark Opacity | `0.2` |
| `WATERMARK_TEXT` | Text to display for watermark | `` |
This image relies on an [Alpine Linux](https://hub.docker.com/r/tiredofit/debian) base image that relies on an [init system](https://github.com/just-containers/s6-overlay) for added capabilities. Outgoing SMTP capabilities are handlded via `msmtp`. Individual container performance monitoring is performed by [zabbix-agent](https://zabbix.org). Additional tools include: `bash`,`curl`,`less`,`logrotate`,`nano`,`vim`.
Be sure to view the following repositories to understand all the customizable options:
| Image | Description |
| ------------------------------------------------------ | -------------------------------------- |
| [OS Base](https://github.com/tiredofit/docker-debian/) | Customized Image based on Debian Linux |
#### General Usage
| Parameter | Description | Default |
| ------------------- | ------------------------------------------------------------------------------------------------------------------ | ------------- |
| `SETUP_TYPE` | Automatically generate configuration with defaults. Set to `MANUAL` and map the configuration file to use your own | `AUTO` |
| `ALLOWED_HOSTS` | Set which domains which can access service Seperate Multiple with `,` - Example: `^(.*)\.example\.org` | |
| `DICTIONARIES` | Spell Check Languages - Available `en_GB en_US` | `en_GB en_US` |
| `EXTRA_OPTIONS` | If you want to pass additional arguments upon startup, add it here | |
| `INTERFACE` | Web interface type `classic` or `notebookbar` | `classic` |
| `WATERMARK_OPACITY` | Watermark Opacity | `0.2` |
| `WATERMARK_TEXT` | Text to display for watermark | `` |
#### Administration
| Parameter | Description | Default |
@ -193,15 +226,35 @@ The following ports are exposed.
| ------ | ------------------------ |
| `9980` | Libreoffice Web Services |
# Maintenance
#### Shell Access
* * *
## Maintenance
### Shell Access
For debugging and maintenance purposes you may want access the containers shell.
```bash
docker exec -it (whatever your container name is e.g. libreoffice-online) bash
```
``bash
docker exec -it (whatever your container name is) bash
``
## Support
These images were built to serve a specific need in a production environment and gradually have had more functionality added based on requests from the community.
### Usage
- The [Discussions board](../../discussions) is a great place for working with the community on tips and tricks of using this image.
- Consider [sponsoring me](https://github.com/sponsors/tiredofit) personalized support.
### Bugfixes
- Please, submit a [Bug Report](issues/new) if something isn't working as expected. I'll do my best to issue a fix in short order.
### Feature Requests
- Feel free to submit a feature request, however there is no guarantee that it will be added, or at what timeline.
- Consider [sponsoring me](https://github.com/sponsors/tiredofit) regarding development of features.
### Updates
- Best effort to track upstream changes, More priority if I am actively using the image in a production environment.
- Consider [sponsoring me](https://github.com/sponsors/tiredofit) for up to date releases.
## License
MIT. See [LICENSE](LICENSE) for more details.
# References
* https://libreoffice.org