Return to README CVS log

Up to [local] / ports / www / owncloud / pkg

Initial revision

$OpenBSD: README,v 1.54 2018/09/04 12:46:25 espie Exp $

+-----------------------------------------------------------------------
| Running ${PKGSTEM} on OpenBSD
+-----------------------------------------------------------------------

ownCloud is installed under
    ${INSTDIR}

Official documentation is available at:
    https://doc.owncloud.org/server/${VR}/admin_manual/

Post-installation instructions
==============================

*** It is highly recommended to use SSL on the webserver (HTTPS).

OpenBSD HTTP daemon
-------------------
httpd(8) example configuration for ownCloud:

---8<---------------------------------------------------------------------------
server "domain.tld" {
	listen on egress tls port 443

	root "/owncloud"
	request strip 1

	tls {
		certificate "/etc/ssl/domain.tld_fullchain.pem"
		key "/etc/ssl/private/domain.tld_private.pem"
	}

	# First deny access to the specified files
	location "/db_structure.xml"    { block }
	location "/.ht*"                { block }
	location "/README"              { block }
	location "/data*"               { block }
	location "/config*"             { block }
	location "/build*"              { block }
	location "/tests*"              { block }
	location "/config*"             { block }
	location "/lib*"                { block }
	location "/3rdparty*"           { block }
	location "/templates*"          { block }
	location "/data*"               { block }
	location "/.ht*"                { block }
	location "/.user*"              { block }
	location "/autotest*"           { block }
	location "/occ*"                { block }
	location "/issue*"              { block }
	location "/indie*"              { block }
	location "/db_*"                { block }
	location "/console*"            { block }

	location "/*.php*" {
		root "/owncloud"
		request strip 1
		fastcgi socket "/run/php-fpm.sock"
	}

	location "/*.php*" {
		fastcgi socket "/run/php-fpm.sock"
	}
}
---8<---------------------------------------------------------------------------

nginx
-----
See:
    https://doc.owncloud.org/server/${VR}/admin_manual/installation/nginx_examples.html

Apache HTTPD
------------
Apache configuration for ownCloud is stored under:
    ${PREFIX}/conf/modules.sample/httpd-owncloud.conf

It needs to be enabled by running the following command after the apache-httpd
package is installed:
# ln -s ../modules.sample/httpd-owncloud.conf /var/www/conf/modules
# rcctl restart apache2

The rewrite_module needs to be enabled by uncommenting the following line in
${SYSCONFDIR}/apache2/httpd2.conf:
    #LoadModule rewrite_module /usr/local/lib/apache2/mod_rewrite.so

PHP
---
Default PHP values for Apache are set under:
    ${TINSTDIR}/.htaccess

OpenBSD HTTP daemon users can match these .htaccess file values by editing
${SYSCONFDIR}/php-${MODPHP_VERSION}.ini or ${SYSCONFDIR}/php-fpm.conf.

nginx users can match these .htaccess file values by configuring fastcgi_param
with a PHP_VALUE in ${SYSCONFDIR}/nginx/nginx.conf.

For enhanced performance, a PHP opcode cache can be used, either use "opcache"
built-in to PHP 5.5+, enable "opcache.ini" to use it)
or install xcache (PHP 5.x only).

Database configuration
----------------------
See the following URL for setting up a database for ownCloud:
    https://doc.owncloud.org/server/${VR}/admin_manual/configuration_database/linux_database_configuration.html

ownCloud can work with a PostgreSQL, MariaDB or SQLite3 database. The
corresponding package needs to be installed *before* setting up ownCloud:
    php-pdo_sqlite, php-pgsql or php-pdo_mysql

ownCloud can work with various database types. Ensure that the package(s) for
PHP support is installed and enabled *before* setting up ownCloud:
	For SQLite:	php-pdo_sqlite and php-sqlite3
	For PostgreSQL:	php-pdo_pgsql
	For MariaDB:	php-pdo_mysql

Configuration file
------------------
Configuration is done under:
    ${INSTDIR}/config/config.php
and the default "datadirectory" is set to:
    ${TINSTDIR}/data
When running chrooted, /var/www must be stripped from the paths.

Cron job
--------
ownCloud needs to run background jobs on a regular basis. By default, it will
execute one task with each page loaded ("AJAX" option in the admin interface).
The prefered way is to use a cron(8) job instead.
(see https://<hostname>/owncloud/index.php/settings/admin#backgroundjobs)
e.g.
*/15	*	*	*	*	su -m www -c "${MODPHP_BIN} -f ${INSTDIR}/cron.php"

Memory caching and file locking
-------------------------------
ownCloud server performance can be significantly improved with memory caching
and memory-based locking. Distributed caching and Transactional File Locking is
provided by Redis, an in-memory data structure store. More information and
configuration example are available at:
    https://doc.owncloud.org/server/${VR}/admin_manual/configuration_server/caching_configuration.html#id4

TL;DR
You need a redis server running (available in the redis package) then adapt and
append the following to:
    ${INSTDIR}/config/config.php

  'filelocking.enabled' => true,
  'memcache.local' => '\OC\Memcache\Redis',
  'memcache.locking' => '\OC\Memcache\Redis',
  'redis' => array(
    'host' => 'localhost',
    'port' => 6379,
    'timeout' => 0.0,
    'password' => '', // Optional, if not defined no password will be used.
  ),

Authentication backends
-----------------------
When using a non-default user authentication backend (LDAP, IMAP, ...), extra
packages may be needed (e.g. php-ldap, php-imap).

Finishing and validating the installation
-----------------------------------------
Make sure the web server can resolve its hostname (e.g. if chrooted, by creating
/var/www/etc/hosts and/or /var/www/etc/resolv.conf).

Accessing https://<hostname>/owncloud with a Web browser will finish the
installation and create a new admin user.

Updating
========
Before updating to a new release, read:
    https://doc.owncloud.org/server/${VR}/admin_manual/maintenance/upgrade.html

WebDAV access
=============
The personal WebDAV share can be accessed using the following URL (e.g. with
Nautilus, Thunar or Doplhin) and the corresponding user and password for the
share:
    https://<hostname>/owncloud/remote.php/webdav/

Synchronization
===============
The "owncloudclient" package (net/owncloudclient) is a graphical (QT)
application to synchronize with an ownCloud server.

Apps and dependencies
=====================
To keep dependencies to a minimum, not all dependencies for all installed apps
are enforced. It is the job of the administrator to manually install required
packages according to the non-default apps he wants to enable.