Annotation of ports/www/owncloud/pkg/README, Revision 1.1.1.1
1.1 kirby 1: $OpenBSD: README,v 1.54 2018/09/04 12:46:25 espie Exp $
2:
3: +-----------------------------------------------------------------------
4: | Running ${PKGSTEM} on OpenBSD
5: +-----------------------------------------------------------------------
6:
7: ownCloud is installed under
8: ${INSTDIR}
9:
10: Official documentation is available at:
11: https://doc.owncloud.org/server/${VR}/admin_manual/
12:
13: Post-installation instructions
14: ==============================
15:
16: *** It is highly recommended to use SSL on the webserver (HTTPS).
17:
18: OpenBSD HTTP daemon
19: -------------------
20: httpd(8) example configuration for ownCloud:
21:
22: ---8<---------------------------------------------------------------------------
23: server "domain.tld" {
24: listen on egress tls port 443
25:
26: root "/owncloud"
27: request strip 1
28:
29: tls {
30: certificate "/etc/ssl/domain.tld_fullchain.pem"
31: key "/etc/ssl/private/domain.tld_private.pem"
32: }
33:
34: # First deny access to the specified files
35: location "/db_structure.xml" { block }
36: location "/.ht*" { block }
37: location "/README" { block }
38: location "/data*" { block }
39: location "/config*" { block }
40: location "/build*" { block }
41: location "/tests*" { block }
42: location "/config*" { block }
43: location "/lib*" { block }
44: location "/3rdparty*" { block }
45: location "/templates*" { block }
46: location "/data*" { block }
47: location "/.ht*" { block }
48: location "/.user*" { block }
49: location "/autotest*" { block }
50: location "/occ*" { block }
51: location "/issue*" { block }
52: location "/indie*" { block }
53: location "/db_*" { block }
54: location "/console*" { block }
55:
56: location "/*.php*" {
57: root "/owncloud"
58: request strip 1
59: fastcgi socket "/run/php-fpm.sock"
60: }
61:
62: location "/*.php*" {
63: fastcgi socket "/run/php-fpm.sock"
64: }
65: }
66: ---8<---------------------------------------------------------------------------
67:
68: nginx
69: -----
70: See:
71: https://doc.owncloud.org/server/${VR}/admin_manual/installation/nginx_examples.html
72:
73: Apache HTTPD
74: ------------
75: Apache configuration for ownCloud is stored under:
76: ${PREFIX}/conf/modules.sample/httpd-owncloud.conf
77:
78: It needs to be enabled by running the following command after the apache-httpd
79: package is installed:
80: # ln -s ../modules.sample/httpd-owncloud.conf /var/www/conf/modules
81: # rcctl restart apache2
82:
83: The rewrite_module needs to be enabled by uncommenting the following line in
84: ${SYSCONFDIR}/apache2/httpd2.conf:
85: #LoadModule rewrite_module /usr/local/lib/apache2/mod_rewrite.so
86:
87: PHP
88: ---
89: Default PHP values for Apache are set under:
90: ${TINSTDIR}/.htaccess
91:
92: OpenBSD HTTP daemon users can match these .htaccess file values by editing
93: ${SYSCONFDIR}/php-${MODPHP_VERSION}.ini or ${SYSCONFDIR}/php-fpm.conf.
94:
95: nginx users can match these .htaccess file values by configuring fastcgi_param
96: with a PHP_VALUE in ${SYSCONFDIR}/nginx/nginx.conf.
97:
98: For enhanced performance, a PHP opcode cache can be used, either use "opcache"
99: built-in to PHP 5.5+, enable "opcache.ini" to use it)
100: or install xcache (PHP 5.x only).
101:
102: Database configuration
103: ----------------------
104: See the following URL for setting up a database for ownCloud:
105: https://doc.owncloud.org/server/${VR}/admin_manual/configuration_database/linux_database_configuration.html
106:
107: ownCloud can work with a PostgreSQL, MariaDB or SQLite3 database. The
108: corresponding package needs to be installed *before* setting up ownCloud:
109: php-pdo_sqlite, php-pgsql or php-pdo_mysql
110:
111: ownCloud can work with various database types. Ensure that the package(s) for
112: PHP support is installed and enabled *before* setting up ownCloud:
113: For SQLite: php-pdo_sqlite and php-sqlite3
114: For PostgreSQL: php-pdo_pgsql
115: For MariaDB: php-pdo_mysql
116:
117: Configuration file
118: ------------------
119: Configuration is done under:
120: ${INSTDIR}/config/config.php
121: and the default "datadirectory" is set to:
122: ${TINSTDIR}/data
123: When running chrooted, /var/www must be stripped from the paths.
124:
125: Cron job
126: --------
127: ownCloud needs to run background jobs on a regular basis. By default, it will
128: execute one task with each page loaded ("AJAX" option in the admin interface).
129: The prefered way is to use a cron(8) job instead.
130: (see https://<hostname>/owncloud/index.php/settings/admin#backgroundjobs)
131: e.g.
132: */15 * * * * su -m www -c "${MODPHP_BIN} -f ${INSTDIR}/cron.php"
133:
134: Memory caching and file locking
135: -------------------------------
136: ownCloud server performance can be significantly improved with memory caching
137: and memory-based locking. Distributed caching and Transactional File Locking is
138: provided by Redis, an in-memory data structure store. More information and
139: configuration example are available at:
140: https://doc.owncloud.org/server/${VR}/admin_manual/configuration_server/caching_configuration.html#id4
141:
142: TL;DR
143: You need a redis server running (available in the redis package) then adapt and
144: append the following to:
145: ${INSTDIR}/config/config.php
146:
147: 'filelocking.enabled' => true,
148: 'memcache.local' => '\OC\Memcache\Redis',
149: 'memcache.locking' => '\OC\Memcache\Redis',
150: 'redis' => array(
151: 'host' => 'localhost',
152: 'port' => 6379,
153: 'timeout' => 0.0,
154: 'password' => '', // Optional, if not defined no password will be used.
155: ),
156:
157: Authentication backends
158: -----------------------
159: When using a non-default user authentication backend (LDAP, IMAP, ...), extra
160: packages may be needed (e.g. php-ldap, php-imap).
161:
162: Finishing and validating the installation
163: -----------------------------------------
164: Make sure the web server can resolve its hostname (e.g. if chrooted, by creating
165: /var/www/etc/hosts and/or /var/www/etc/resolv.conf).
166:
167: Accessing https://<hostname>/owncloud with a Web browser will finish the
168: installation and create a new admin user.
169:
170: Updating
171: ========
172: Before updating to a new release, read:
173: https://doc.owncloud.org/server/${VR}/admin_manual/maintenance/upgrade.html
174:
175: WebDAV access
176: =============
177: The personal WebDAV share can be accessed using the following URL (e.g. with
178: Nautilus, Thunar or Doplhin) and the corresponding user and password for the
179: share:
180: https://<hostname>/owncloud/remote.php/webdav/
181:
182: Synchronization
183: ===============
184: The "owncloudclient" package (net/owncloudclient) is a graphical (QT)
185: application to synchronize with an ownCloud server.
186:
187: Apps and dependencies
188: =====================
189: To keep dependencies to a minimum, not all dependencies for all installed apps
190: are enforced. It is the job of the administrator to manually install required
191: packages according to the non-default apps he wants to enable.
CVSweb