mirekys / bitnami-docker-owncloud

Bitnami Docker Image for ownCloud

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

ownCloud packaged by Bitnami

What is ownCloud?

ownCloud is an open source content collaboration platform used to store and share files from any device. It grants data privacy, synchronization between devices, and file access control.

Overview of ownCloud

Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.

TL;DR

$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-owncloud/master/docker-compose.yml > docker-compose.yml
$ docker-compose up -d

Warning: This quick setup is only intended for development environments. You are encouraged to change the insecure default credentials and check out the available configuration options in the Environment Variables section for a more secure deployment.

Why use Bitnami Images?

  • Bitnami closely tracks upstream source changes and promptly publishes new versions of this image using our automated systems.
  • With Bitnami images the latest bug fixes and features are available as soon as possible.
  • Bitnami containers, virtual machines and cloud images use the same components and configuration approach - making it easy to switch between formats based on your project needs.
  • All our images are based on minideb a minimalist Debian based container image which gives you a small base container image and the familiarity of a leading Linux distribution.
  • All Bitnami images available in Docker Hub are signed with Docker Content Trust (DCT). You can use DOCKER_CONTENT_TRUST=1 to verify the integrity of the images.
  • Bitnami container images are released on a regular basis with the latest distribution packages available.

Supported tags and respective Dockerfile links

Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags in our documentation page.

Subscribe to project updates by watching the bitnami/owncloud GitHub repo.

Get this image

The recommended way to get the Bitnami ownCloud Docker Image is to pull the prebuilt image from the Docker Hub Registry.

$ docker pull bitnami/owncloud:latest

To use a specific version, you can pull a versioned tag. You can view the list of available versions in the Docker Hub Registry.

$ docker pull bitnami/owncloud:[TAG]

If you wish, you can also build the image yourself.

$ docker build -t bitnami/owncloud:latest 'https://github.com/bitnami/bitnami-docker-owncloud.git#master:10/debian-11'

How to use this image

ownCloud requires access to a MySQL or MariaDB database to store information. We'll use the Bitnami Docker Image for MariaDB for the database requirements.

Run the application using Docker Compose

The main folder of this repository contains a functional docker-compose.yml file. Run the application using it as shown below:

$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-owncloud/master/docker-compose.yml > docker-compose.yml
$ docker-compose up -d

Using the Docker Command Line

If you want to run the application manually instead of using docker-compose, these are the basic steps you need to run:

Step 1: Create a network

$ docker network create owncloud-network

Step 2: Create a volume for MariaDB persistence and create a MariaDB container

$ docker volume create --name mariadb_data
$ docker run -d --name mariadb \
  --env ALLOW_EMPTY_PASSWORD=yes \
  --env MARIADB_USER=bn_owncloud \
  --env MARIADB_PASSWORD=bitnami \
  --env MARIADB_DATABASE=bitnami_owncloud \
  --network owncloud-network \
  --volume mariadb_data:/bitnami/mariadb \
  bitnami/mariadb:latest

Step 3: Create volumes for ownCloud persistence and launch the container

$ docker volume create --name owncloud_data
$ docker run -d --name owncloud \
  -p 8080:8080 -p 8443:8443 \
  --env ALLOW_EMPTY_PASSWORD=yes \
  --env OWNCLOUD_DATABASE_USER=bn_owncloud \
  --env OWNCLOUD_DATABASE_PASSWORD=bitnami \
  --env OWNCLOUD_DATABASE_NAME=bitnami_owncloud \
  --network owncloud-network \
  --volume owncloud_data:/bitnami/owncloud \
  bitnami/owncloud:latest

Access your application at http://your-ip/

Persisting your application

If you remove the container all your data will be lost, and the next time you run the image the database will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed.

For persistence you should mount a directory at the /bitnami/owncloud path. If the mounted directory is empty, it will be initialized on the first run. Additionally you should mount a volume for persistence of the MariaDB data](https://github.com/bitnami/bitnami-docker-mariadb#persisting-your-database).

The above examples define the Docker volumes named mariadb_data and owncloud_data. The ownCloud application state will persist as long as volumes are not removed.

To avoid inadvertent removal of volumes, you can mount host directories as data volumes. Alternatively you can make use of volume plugins to host the volume data.

Mount host directories as data volumes with Docker Compose

This requires a minor change to the docker-compose.yml file present in this repository:

   mariadb:
     ...
     volumes:
-      - 'mariadb_data:/bitnami/mariadb'
+      - /path/to/mariadb-persistence:/bitnami/mariadb
   ...
   owncloud:
     ...
     volumes:
-      - 'owncloud_data:/bitnami/owncloud'
+      - /path/to/owncloud-persistence:/bitnami/owncloud
   ...
-volumes:
-  mariadb_data:
-    driver: local
-  owncloud_data:
-    driver: local

Mount host directories as data volumes using the Docker command line

Step 1: Create a network (if it does not exist)

$ docker network create owncloud-network

Step 2. Create a MariaDB container with host volume

$ docker run -d --name mariadb \
  --env ALLOW_EMPTY_PASSWORD=yes \
  --env MARIADB_USER=bn_owncloud \
  --env MARIADB_PASSWORD=bitnami \
  --env MARIADB_DATABASE=bitnami_owncloud \
  --network owncloud-network \
  --volume /path/to/mariadb-persistence:/bitnami/mariadb \
  bitnami/mariadb:latest

Step 3. Create the ownCloud container with host volumes

$ docker run -d --name owncloud \
  -p 8080:8080 -p 8443:8443 \
  --env ALLOW_EMPTY_PASSWORD=yes \
  --env OWNCLOUD_DATABASE_USER=bn_owncloud \
  --env OWNCLOUD_DATABASE_PASSWORD=bitnami \
  --env OWNCLOUD_DATABASE_NAME=bitnami_owncloud \
  --network owncloud-network \
  --volume /path/to/owncloud-persistence:/bitnami/owncloud \
  bitnami/owncloud:latest

Configuration

Environment variables

When you start the ownCloud image, you can adjust the configuration of the instance by passing one or more environment variables either on the docker-compose file or on the docker run command line. If you want to add a new environment variable:

  • For docker-compose add the variable name and value under the application section in the docker-compose.yml file present in this repository:
owncloud:
  ...
  environment:
    - OWNCLOUD_PASSWORD=my_password
  ...
  • For manual execution add a --env option with each variable and value:
$ docker run -d --name owncloud -p 80:8080 -p 443:8443 \
  --env OWNCLOUD_PASSWORD=my_password \
  --network owncloud-tier \
  --volume /path/to/owncloud-persistence:/bitnami \
  bitnami/owncloud:latest

Available environment variables:

User and Site configuration
  • APACHE_HTTP_PORT_NUMBER: Port used by Apache for HTTP. Default: 8080
  • APACHE_HTTPS_PORT_NUMBER: Port used by Apache for HTTPS. Default: 8443
  • OWNCLOUD_USERNAME: ownCloud application username. Default: user
  • OWNCLOUD_PASSWORD: ownCloud application password. Default: bitnami
  • OWNCLOUD_EMAIL: ownCloud application email. Default: user@example.com
  • OWNCLOUD_SKIP_BOOTSTRAP: Whether to skip performing the initial bootstrapping for the application. Default: no
  • OWNCLOUD_HOST: ownCloud host to configure internal paths. Default: set to the machine ip
Use an existing database
  • OWNCLOUD_DATABASE_TYPE: Database type to use. Valid values: mysql, sqlite. Default: mysql
  • OWNCLOUD_DATABASE_HOST: Hostname for MariaDB server. Default: mariadb
  • OWNCLOUD_DATABASE_PORT_NUMBER: Port used by MariaDB server. Default: 3306
  • OWNCLOUD_DATABASE_NAME: Database name that ownCloud will use to connect with the database. Default: bitnami_owncloud
  • OWNCLOUD_DATABASE_USER: Database user that ownCloud will use to connect with the database. Default: bn_owncloud
  • OWNCLOUD_DATABASE_PASSWORD: Database password that ownCloud will use to connect with the database. No defaults.
  • ALLOW_EMPTY_PASSWORD: It can be used to allow blank passwords. Default: no
Create a database for ownCloud using mysql-client
  • MYSQL_CLIENT_FLAVOR: SQL database flavor. Valid values: mariadb or mysql. Default: mariadb.
  • MYSQL_CLIENT_DATABASE_HOST: Hostname for MariaDB server. Default: mariadb
  • MYSQL_CLIENT_DATABASE_PORT_NUMBER: Port used by MariaDB server. Default: 3306
  • MYSQL_CLIENT_DATABASE_ROOT_USER: Database admin user. Default: root
  • MYSQL_CLIENT_DATABASE_ROOT_PASSWORD: Database password for the database admin user. No defaults.
  • MYSQL_CLIENT_CREATE_DATABASE_NAME: New database to be created by the mysql client module. No defaults.
  • MYSQL_CLIENT_CREATE_DATABASE_USER: New database user to be created by the mysql client module. No defaults.
  • MYSQL_CLIENT_CREATE_DATABASE_PASSWORD: Database password for the MYSQL_CLIENT_CREATE_DATABASE_USER user. No defaults.
  • MYSQL_CLIENT_CREATE_DATABASE_CHARACTER_SET: Character set to use for the new database. No defaults.
  • MYSQL_CLIENT_CREATE_DATABASE_COLLATE: Database collation to use for the new database. No defaults.
  • MYSQL_CLIENT_CREATE_DATABASE_PRIVILEGES: Database privileges to grant for the user specified in MYSQL_CLIENT_CREATE_DATABASE_USER to the database specified in MYSQL_CLIENT_CREATE_DATABASE_NAME. No defaults.
  • MYSQL_CLIENT_ENABLE_SSL_WRAPPER: Whether to force SSL connections to the database via the mysql CLI tool. Useful for applications that rely on the CLI instead of APIs. Default: no
  • MYSQL_CLIENT_ENABLE_SSL: Whether to force SSL connections for the database. Default: no
  • MYSQL_CLIENT_SSL_CA_FILE: Path to the SSL CA file for the new database. No defaults
  • MYSQL_CLIENT_SSL_CERT_FILE: Path to the SSL CA file for the new database. No defaults
  • MYSQL_CLIENT_SSL_KEY_FILE: Path to the SSL CA file for the new database. No defaults
  • ALLOW_EMPTY_PASSWORD: It can be used to allow blank passwords. Default: no
SMTP Configuration

To configure ownCloud to send email using SMTP you can set the following environment variables:

  • OWNCLOUD_SMTP_HOST: SMTP host.
  • OWNCLOUD_SMTP_PORT_NUMBER: SMTP port.
  • OWNCLOUD_SMTP_USER: SMTP account user.
  • OWNCLOUD_SMTP_PASSWORD: SMTP account password.
  • SUITECRM_SMTP_PROTOCOL: SMTP protocol to use.
PHP configuration
  • PHP_ENABLE_OPCACHE: Enable OPcache for PHP scripts. No default.
  • PHP_EXPOSE_PHP: Enables HTTP header with PHP version. No default.
  • PHP_MAX_EXECUTION_TIME: Maximum execution time for PHP scripts. No default.
  • PHP_MAX_INPUT_TIME: Maximum input time for PHP scripts. No default.
  • PHP_MAX_INPUT_VARS: Maximum amount of input variables for PHP scripts. No default.
  • PHP_MEMORY_LIMIT: Memory limit for PHP scripts. Default: 512M
  • PHP_POST_MAX_SIZE: Maximum size for PHP POST requests. Default: 2G
  • PHP_UPLOAD_MAX_FILESIZE: Maximum file size for PHP uploads. Default: 2G
Example

This would be an example of SMTP configuration using a Gmail account:

  owncloud:
    ...
    environment:
      - OWNCLOUD_DATABASE_USER=bn_owncloud
      - OWNCLOUD_DATABASE_NAME=bitnami_owncloud
      - ALLOW_EMPTY_PASSWORD=yes
      - OWNCLOUD_SMTP_HOST=smtp.gmail.com
      - OWNCLOUD_SMTP_PORT=587
      - OWNCLOUD_SMTP_USER=your_email@gmail.com
      - OWNCLOUD_SMTP_PASSWORD=your_password
  ...
  • For manual execution:
$ docker run -d --name owncloud -p 80:8080 -p 443:8443 \
  --env OWNCLOUD_DATABASE_USER=bn_owncloud \
  --env OWNCLOUD_DATABASE_NAME=bitnami_owncloud \
  --env OWNCLOUD_SMTP_HOST=smtp.gmail.com \
  --env OWNCLOUD_SMTP_PORT=587 \
  --env OWNCLOUD_SMTP_USER=your_email@gmail.com \
  --env OWNCLOUD_SMTP_PASSWORD=your_password \
  --network owncloud-tier \
  --volume /path/to/owncloud-persistence:/bitnami \
  bitnami/owncloud:latest

Logging

The Bitnami ownCloud Docker image sends the container logs to stdout. To view the logs:

$ docker logs owncloud

Or using Docker Compose:

$ docker-compose logs owncloud

You can configure the containers logging driver using the --log-driver option if you wish to consume the container logs differently. In the default configuration docker uses the json-file driver.

Maintenance

Backing up your container

To backup your data, configuration and logs, follow these simple steps:

Step 1: Stop the currently running container

$ docker stop owncloud

Or using Docker Compose:

$ docker-compose stop owncloud

Step 2: Run the backup command

We need to mount two volumes in a container we will use to create the backup: a directory on your host to store the backup in, and the volumes from the container we just stopped so we can access the data.

$ docker run --rm -v /path/to/owncloud-backups:/backups --volumes-from owncloud busybox \
  cp -a /bitnami/owncloud /backups/latest

Restoring a backup

Restoring a backup is as simple as mounting the backup as volumes in the containers.

For the MariaDB database container:

 $ docker run -d --name mariadb \
   ...
-  --volume /path/to/mariadb-persistence:/bitnami/mariadb \
+  --volume /path/to/mariadb-backups/latest:/bitnami/mariadb \
   bitnami/mariadb:latest

For the ownCloud container:

 $ docker run -d --name owncloud \
   ...
-  --volume /path/to/owncloud-persistence:/bitnami/owncloud \
+  --volume /path/to/owncloud-backups/latest:/bitnami/owncloud \
   bitnami/owncloud:latest

Upgrade this image

Bitnami provides up-to-date versions of MariaDB and ownCloud, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. We will cover here the upgrade of the ownCloud container. For the MariaDB upgrade see: https://github.com/bitnami/bitnami-docker-mariadb/blob/master/README.md#upgrade-this-image

Step 1: Get the updated image

$ docker pull bitnami/owncloud:latest

Step 2: Stop the running container

Stop the currently running container using the command

$ docker-compose stop owncloud

Step 3: Take a snapshot of the application state

Follow the steps in Backing up your container to take a snapshot of the current application state.

Step 4: Remove the currently running container

Remove the currently running container by executing the following command:

docker-compose rm -v owncloud

Step 5: Run the new image

Update the image tag in docker-compose.yml and re-create your container with the new image:

$ docker-compose up -d

Customize this image

The Bitnami ownCloud Docker image is designed to be extended so it can be used as the base image for your custom web applications.

Extend this image

Before extending this image, please note there are certain configuration settings you can modify using the original image:

If your desired customizations cannot be covered using the methods mentioned above, extend the image. To do so, create your own image using a Dockerfile with the format below:

FROM bitnami/owncloud
## Put your customizations below
...

Here is an example of extending the image with the following modifications:

  • Install the vim editor
  • Modify the Apache configuration file
  • Modify the ports used by Apache
FROM bitnami/owncloud

## Install 'vim'
RUN install_packages vim

## Enable mod_ratelimit module
RUN sed -i -r 's/#LoadModule ratelimit_module/LoadModule ratelimit_module/' /opt/bitnami/apache/conf/httpd.conf

## Modify the ports used by Apache by default
# It is also possible to change these environment variables at runtime
ENV APACHE_HTTP_PORT_NUMBER=8181
ENV APACHE_HTTPS_PORT_NUMBER=8143
EXPOSE 8181 8143

Based on the extended image, you can update the docker-compose.yml file present in this repository to add other features:

   owncloud:
-    image: bitnami/owncloud:latest
+    build: .
     ports:
-      - '80:8080'
-      - '443:8443'
+      - '80:8181'
+      - '443:8143'
     environment:
+      - PHP_MEMORY_LIMIT=512m
     ...

Notable Changes

10.6.0-debian-10-r18

  • The size of the container image has been decreased.
  • The configuration logic is now based on Bash scripts in the rootfs/ folder.
  • The ownCloud container now supports the "non-root" user approach, but it still runs as the root user by default. When running as a non-root user, all services will be run under the same user and Cron jobs will be disabled as crond requires to be run as a superuser. To run as a non-root user, change USER root to USER 1001 in the Dockerfile, or use user: 1001 in docker-compose.yml. Related changes:
    • The HTTP/HTTPS ports exposed by the container are now 8080/8443 instead of 80/443.
    • Backwards compatibility is not guaranteed when data is persisted using docker or docker-compose. We highly recommend migrating the ownCloud site by exporting its content, and importing it on a new ownCloud container. Follow the steps in Backing up your container and Restoring a backup to migrate the data between the old and new container.

To upgrade a deployment with the previous Bitnami SuiteCRM container image, which did not support non-root, the easiest way is to start the new image as a root user and updating the port numbers. Modify your docker-compose.yml file as follows:

      - OWNCLOUD_HOST=localhost
+    user: root
     ports:
-      - '80:80'
-      - '443:443'
+      - '80:8080'
+      - '443:8443'
     volumes:

10.2.0-debian-9-r8 and 10.2.0-ol-7-r8

  • This image has been adapted so it's easier to customize. See the Customize this image section for more information.
  • The Apache configuration volume (/bitnami/apache) has been deprecated, and support for this feature will be dropped in the near future. Until then, the container will enable the Apache configuration from that volume if it exists. By default, and if the configuration volume does not exist, the configuration files will be regenerated each time the container is created. Users wanting to apply custom Apache configuration files are advised to mount a volume for the configuration at /opt/bitnami/apache/conf, or mount specific configuration files individually.
  • The PHP configuration volume (/bitnami/php) has been deprecated, and support for this feature will be dropped in the near future. Until then, the container will enable the PHP configuration from that volume if it exists. By default, and if the configuration volume does not exist, the configuration files will be regenerated each time the container is created. Users wanting to apply custom PHP configuration files are advised to mount a volume for the configuration at /opt/bitnami/php/conf, or mount specific configuration files individually.
  • Enabling custom Apache certificates by placing them at /opt/bitnami/apache/certs has been deprecated, and support for this functionality will be dropped in the near future. Users wanting to enable custom certificates are advised to mount their certificate files on top of the preconfigured ones at /certs.

Contributing

We'd love for you to contribute to this container. You can request new features by creating an issue, or submit a pull request with your contribution.

Issues

If you encountered a problem running this container, you can file an issue. Be sure to include the following information in your issue:

  • Host OS and version
  • Docker version (docker version)
  • Output of docker info
  • Version of this container
  • The command you used to run the container, and any relevant output you saw (masking any sensitive information)

Community supported solution

Please, note this asset is a community-supported solution. This means that the Bitnami team is not actively working on new features/improvements nor providing support through GitHub Issues. Any new issue will stay open for 20 days to allow the community to contribute, after 15 days without activity the issue will be marked as stale being closed after 5 days.

The Bitnami team will review any PR that is created, feel free to create a PR if you find any issue or want to implement a new feature.

New versions and releases cadence are not going to be affected. Once a new version is released in the upstream project, the Bitnami container image will be updated to use the latest version, supporting the different branches supported by the upstream project as usual.

License

Copyright © 2022 Bitnami

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

About

Bitnami Docker Image for ownCloud

License:Other


Languages

Language:Shell 95.7%Language:Smarty 2.8%Language:Dockerfile 1.5%