khanh.pndc/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-01-04 10:46:21 +07:00
Code Issues Packages Projects Releases Wiki Activity

consolidated and repaired formatting on performance tips pages

Browse Source
This commit is contained in:
Carla Schroder
2015-03-09 16:01:43 -07:00
parent 4ba9d659d3
commit 5e6e05d73f
3 changed files with 408 additions and 357 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
admin_manual/configuration_server/index.rst
View File

@@ -16,7 +16,6 @@ ownCloud Server Configuration
language_configuration
logging_configuration
occ_command
performance_tips
performance_tuning
reverse_proxy_configuration

275
admin_manual/configuration_server/performance_tips.rst
View File

@@ -1,275 +0,0 @@
Performance Tips
================
The performance of ownCloud, like any `LAMP application <http://wikipedia.org/wiki/LAMP_%28software_bundle%29>`_,
is dependent on all components of the stack.
Maximizing performance can be achieved by optimizing the operations and interactions
of the underlying network, hardware, operating systems, webservers, databases, and storage.
This guide cannot cover all possible configurations and will instead
cover tips that are specific to ownCloud or give the greatest benefit.
SSL / Encryption App
--------------------
SSL (HTTPS) and file encryption/decryption can be offloaded to a processor's AES-NI extension.
This can both speed up these operations while lowering processing overhead.
This requires a processor with the `AES-NI instruction set <http://wikipedia.org/wiki/AES_instruction_set>`_.
Here are some examples how to check if your CPU / environment supports the AES-NI extension:
* | For each CPU core present: ``grep flags /proc/cpuinfo``
| or as a summary for all cores: ``grep -m 1 ^flags /proc/cpuinfo``
| If the result contains any ``aes``, the extension is present.
|
* | On Windows you can run ``coreinfo`` from Sysinternals
| `Windows Sysinternals Download Coreinfo <https://technet.microsoft.com/en-us/sysinternals/cc835722.aspx>`_
| which gives you details of the processor and extensions present.
| Note: you may have to run the command shell as administrator to get an output.
|
* | Search eg. on the Intel web if the processor used supports the extension
| `Intel Processor Feature Filter <http://ark.intel.com/MySearch.aspx?AESTech=true>`_
| You may set a filter by ``"AES New Instructions"`` to get a reduced result set.
|
* | For versions of openssl >= 1.0.1, AES-NI does not work via an engine and will not show up in the ``openssl engine`` command. It is active by default on the supported hardware.
| You can check the openssl version via ``openssl version -a``
|
* | If your processor supports AES-NI but it does not show up eg via grep or coreinfo, it is maybe disabled in the BIOS.
|
* | If your environment runs virtualized, check the virtualization vendor for support.
|
OPcache Extension
-----------------
OPcache improves PHP performance by storing precompiled script bytecode in shared memory,
thereby removing the need for PHP to load and parse scripts on each request.
This extension is bundled with PHP 5.5.0 and later, and is available in PECL for PHP versions 5.2, 5.3, and 5.4.
Object Caching
--------------
ownCloud is written to take advantage of object caching.
Object caching can be done locally with the APCu extension,
or for distributed PHP environments using Memcached.
Memcached servers must be specified in the "memcached_servers" array in ownCloud's config file.
Enable the SPDY protocol
------------------------
Your webserver can be configured to use the SPDY protocol which could improve the overall performance of ownCloud.
Please have a look at the documentation of your webservers module for more infos:
* | `mod-spdy for Apache <https://code.google.com/p/mod-spdy/>`_
|
* | `ngx_http_spdy_module for NginX <http://nginx.org/en/docs/http/ngx_http_spdy_module.html>`_
|
.. note:: If you want to enable SPDY for Apache please note the `Known Issues <https://code.google.com/p/mod-spdy/wiki/KnownIssues>`_
of this module to avoid problems after enabling it.
Serving static files via web server
-----------------------------------
See the section
:doc:`../configuration_files/serving_static_files_configuration` for a
description and the benefits.
Using cron to perform background jobs
-------------------------------------
See the section :doc:`background_jobs_configuration` for a description and the benefits.
Using MySQL instead of SQLite
-----------------------------
MySQL or MariaDB should be preferred because of the `performance limitations of SQLite with highly concurrent applications <http://www.sqlite.org/whentouse.html>`_, like ownCloud.
On large instances you could consider `running MySQLTuner <https://github.com/major/MySQLTuner-perl/>`_ to optimize the database.
See the section :doc:`../configuration_database/linux_database_configuration`
how to configure ownCloud for MySQL or MariaDB. If your installation is already
running on
SQLite then it is possible to convert to MySQL or MariaDB using the steps
provided in :doc:`../configuration_database/db_conversion`.
Improve slow performance with MySQL on Windows
----------------------------------------------
On Windows hosts running MySQL on the same system changing the parameter ``dbhost`` in your ``config/config.php``
from ``localhost`` to ``127.0.0.1`` could improve the page loading time.
See also `this forum thread <http://forum.owncloud.org/viewtopic.php?f=17&t=7559>`_.
Nginx: caching ownCloud gallery thumbnails with fastcgi_cache_purge
-------------------------------------------------------------------
| One of the optimisations for ownCloud when using Nginx as webserver is to combine FastCGI caching with "Cache Purge", a `3rdparty Nginx module <http://wiki.nginx.org/3rdPartyModules>`_ that adds the ability to purge content from `FastCGI`, `proxy`, `SCGI` and `uWSGI` caches. This mechanism speeds up thumbnail presentation as it shifts requests to Nginx and minimizes php invocations which else would take place for every thumbnail presented every time.
| The following procedure is based on an Ubuntu 14.04 system. You may need to adopt it according your OS type and release.
| **Note I:**
| Unlike Apache, Nginx does not dynamically load modules. All modules needed, must be compiled into Nginx. This is one of the reasons for Nginx´s performance.
| **Note II:**
| It is expected to have an already running Nginx installation with a working configuration set up like described in the ownCloud documentation.
Nginx module check
~~~~~~~~~~~~~~~~~~
| As a first step, it is necessary to check if your Nginx installation has the ``nginx cache purge`` module compiled in.
|
| ``nginx -V 2>&1 | grep ngx_cache_purge -o``
|
| If your output contains ``ngx_cache_purge``, you can continue with the configuration, else you need to manually compile Nginx with the module needed.
Compile Nginx with the ``nginx-cache-purge`` module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1. | *Preparation*
| ``cd /opt``
| ``wget http://nginx.org/keys/nginx_signing.key``
| ``sudo apt-key add nginx_signing.key``
| ``sudo vi /etc/apt/sources.list.d/nginx.list``
|
| Add following lines (in case, replace ``{trusty}`` by your distribution name):
| ``deb http://nginx.org/packages/mainline/ubuntu/ trusty nginx``
| ``deb -src http://nginx.org/packages/mainline/ubuntu/ trusty nginx``
|
| Then do a
| ``sudo apt-get update``
|
| **Note:**
| If you're not overly cautious and wish to install the latest and greatest Nginx packages and features, you may have to install Nginx from its mainline repository.
| From the Nginx homepage: "In general, you should deploy Nginx from its mainline branch at all times."
|
| If you would like to use standard Nginx from the latest mainline branch but without compiling in any additional modules, just run ``sudo apt-get install nginx``.
|
2. | *Download the Nginx source from the ppa repository*
| ``cd /opt``
| ``sudo apt-get build-dep nginx``
| ``sudo apt-get source nginx``
|
3. | *Download module(s) to be compiled in and configure compiler arguments*
| ``ls -la``
|
| Please replace ``{release}`` with the release downloaded
| ``cd /opt/nginx-{release}/debian``
|
| If folder "modules" is not present, do:
| ``sudo mkdir modules``
| ``cd modules``
| ``sudo git clone https://github.com/FRiCKLE/ngx_cache_purge.git``
| ``sudo vi /opt/nginx-{release}/debian/rules``
|
| If not present, add the following line at the top under ``#export DH_VERBOSE=1``:
| ``MODULESDIR = $(CURDIR)/debian/modules``
|
| And the end of `every` ``./configure`` command add:
| ``--add-module=$(MODULESDIR)/ngx_cache_purge``
|
| Don't forget to escape preceeding lines with a backslash ``\``.
| The parameters may now look :
| ``$(WITH_SPDY) \``
| ``--with-cc-opt="$(CFLAGS)" \``
| ``--with-ld-opt="$(LDFLAGS)" \``
| ``--with-ipv6 \``
| ``--add-module=$(MODULESDIR)/ngx_cache_purge``
|
4. | *Compile and install Nginx*
| ``cd /opt/nginx-{release}``
| ``sudo dpkg-buildpackage -uc -b``
| ``ls -la /opt``
| ``sudo dpkg --install /opt/nginx_{release}~{distribution}_amd64.deb``
|
5. | *Check if the compilation and installation of the* ``ngx_cache_purge`` *module was successful*
| ``nginx -V 2>&1 | grep ngx_cache_purge -o``
|
| It should show now: ``ngx_cache_purge``
|
| Show Nginx version including all features compiled and installed:
| ``nginx -V 2>&1 | sed s/" --"/"\n\t--"/g``
|
6. | *Mark Nginx to be blocked from further updates via* ``apt-get``
| ``sudo dpkg --get-selections | grep nginx``
|
| For eyery nginx component listed do a:
| ``sudo apt-mark hold <component>``
|
7. | *Regular checks for nginx updates*
| Do a regular visit on the `Nginx news page <http://nginx.org>`_ and proceed in case of updates with item 2 to 5
Configure Nginx with the ``nginx-cache-purge`` module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1. | *Preparation*
| Create a directory where Nginx will save the cached thumbnails. Use any path that fits to your environment. Replace ``{path}`` with the path used, example path below:
| ``sudo mkdir -p /usr/local/tmp/cache``
|
2. | *Configuration*
| ``sudo vi /etc/nginx/sites-enabled/{your-ownCloud-nginx-config-file}``
|
| Note: the ``keys_zone`` / ``fastcgi_cache`` name and the ``{path}`` must be unique to each instance of ownCloud serverd with Nginx !
|
| Add at the *beginning*, but *outside* the ``server{}`` block:
| ``fastcgi_cache_path {path} levels=1:2 keys_zone=OWNCLOUD:100m inactive=60m;``
|
| Add *inside* the ``server{}`` block, as an example of a configuration:
|
| ``set $skip_cache 1;``
|
| ``# POST requests and urls with a query string should always go to PHP``
| ``if ($request_uri ~* "thumbnail.php") {``
| ``set $skip_cache 0;``
| ``}``
|
| ``fastcgi_cache_key "$scheme$request_method$host$request_uri";``
| ``fastcgi_cache_use_stale error timeout invalid_header http_500;``
| ``fastcgi_ignore_headers Cache-Control Expires Set-Cookie;``
|
| ``location ~ \.php(?:$|/) {``
| ``fastcgi_split_path_info ^(.+\.php)(/.+)$;``
|
| ``include fastcgi_params;``
| ``fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;``
| ``fastcgi_param PATH_INFO $fastcgi_path_info;``
| ``fastcgi_param HTTPS on;``
| ``fastcgi_pass php-handler;``
|
| ``fastcgi_cache_bypass $skip_cache;``
| ``fastcgi_no_cache $skip_cache;``
| ``fastcgi_cache OWNCLOUD;``
| ``fastcgi_cache_valid 60m;``
| ``}``
|
| Note regarding the ``fastcgi_pass`` parameter:
| Use whatever fits your configuration. In the example above, a ``upstream`` was defined in an Nginx global configuration file.
| This then can look like:
|
| ``upstream php-handler {``
| ``server 127.0.0.1:9000;``
| ``# or``
| ``#server unix:/var/run/php5-fpm.sock;``
| ``}``
|
3. | *Test the configuration*
| ``sudo service nginx restart``
* | Open your browser and clear your cache.
* | Logon to your ownCloud instance, open the gallery app, move thru your folders
| and watch while the thumbs are generated for the first time.
* | You may also watch with eg. ``htop`` your system load while the thumbnails are processed.
* | Goto another app or logout and relogon.
* | Open the gallery app again and browse to the folders you accessed before.
| Your thumbnails should appear more or less immediately.
* | ``htop`` will not show up additional load while processing, compared to the high load before.

489
admin_manual/configuration_server/performance_tuning.rst
View File

@@ -1,6 +1,6 @@
=============
Server Tuning
=============
################################
Server Tuning & Performance Tips
################################
.. toctree::
:maxdepth: 2
@@ -17,12 +17,12 @@ deployment.
This chapter gives a few hands-on tips on how to achieve this.
********************
General Linux tuning
====================
********************
System configuration overview
-----------------------------
=============================
.. code-block:: console
@@ -38,16 +38,14 @@ performance. To do so, add the following to ``/etc/fstab``::
none /tmp tmpfs,size=6g defaults
Make surethe APC byte code cache is installed:
Make sure the APC byte code cache is installed:
.. code-block:: console
# yum install php-pecl-apc
mysql temp in ramdisk
Tuning System Parameters
------------------------
========================
Configuration for more concurrent requests.
@@ -92,8 +90,8 @@ Next, persist the settings across reboots by adding them into ``/etc/sysctl.conf
net.ipv4.tcp_max_syn_backlog = 65536
net.netfilter.nf_conntrack_max = 262144
Tuning
------
Tuning Memory
=============
Add RAM disk to fstab::
@@ -112,20 +110,112 @@ directory.
.. note:: ram disks are not reboot-safe. You need to establish a way to persist them,
for instance by using ``cp`` or ``rsync`` to transfer them from a location
on the hard disk to the ram disk before apache starts.
**********************
ownCloud Server Tuning
**********************
Object Caching
==============
ownCloud is written to take advantage of object caching. Object caching can be
done locally with the APCu extension, or for distributed PHP environments using
Memcached. Memcached servers must be specified in the "memcached_servers" array
in ownCloud's config file.
Serving static files via web server
===================================
See the section
:doc:`../configuration_files/serving_static_files_configuration` for a
description and the benefits.
Using cron to perform background jobs
=====================================
See the section :doc:`background_jobs_configuration` for a description and the
benefits.
OPcache Extension
=================
OPcache improves PHP performance by storing precompiled script bytecode in
shared memory, thereby removing the need for PHP to load and parse scripts on
each request. This extension is bundled with PHP 5.5.0 and later, and is
available in PECL for PHP versions 5.2, 5.3, and 5.4.
********************
SSL / Encryption App
********************
SSL (HTTPS) and file encryption/decryption can be offloaded to a processor's
AES-NI extension. This can both speed up these operations while lowering
processing overhead. This requires a processor with the `AES-NI instruction set
<http://wikipedia.org/wiki/AES_instruction_set>`_.
Here are some examples how to check if your CPU / environment supports the
AES-NI extension:
* For each CPU core present: ``grep flags /proc/cpuinfo`` or as a summary for
all cores: ``grep -m 1 ^flags /proc/cpuinfo`` If the result contains any
``aes``, the extension is present.
* On Windows you can run ``coreinfo`` from Sysinternals `Windows Sysinternals
Download Coreinfo
<https://technet.microsoft.com/en-us/sysinternals/cc835722.aspx>`_ which
gives you details of the processor and extensions present. Note: you may have
to run the command shell as administrator to get an output.
* Search eg. on the Intel web if the processor used supports the extension
`Intel Processor Feature Filter
<http://ark.intel.com/MySearch.aspx?AESTech=true>`_ You may set a filter by
``"AES New Instructions"`` to get a reduced result set.
* For versions of openssl >= 1.0.1, AES-NI does not work via an engine and
will not show up in the ``openssl engine`` command. It is active by default
on the supported hardware. You can check the openssl version via ``openssl
version -a``
* If your processor supports AES-NI but it does not show up eg via grep or
coreinfo, it is maybe disabled in the BIOS.
* If your environment runs virtualized, check the virtualization vendor for
support.
**************
Webserver Tips
**************
Enable the SPDY protocol
========================
Your webserver can be configured to use the SPDY protocol which could improve
the overall performance of ownCloud. Please have a look at the documentation of
your webservers module for more information:
* `mod-spdy for Apache <https://code.google.com/p/mod-spdy/>`_
* `ngx_http_spdy_module for NginX
<http://nginx.org/en/docs/http/ngx_http_spdy_module.html>`_
.. note:: If you want to enable SPDY for Apache please note the `Known Issues
<https://code.google.com/p/mod-spdy/wiki/KnownIssues>`_
of this module to avoid problems after enabling it.
*************
Apache Tuning
=============
*************
Maximum number Apache processes
-------------------------------
An apache process is using around 12MB of RAM. Apache should be configured that the maximum number of httpd processes
time 12MB is lower than the amount of RAM. Otherwise the system begins to swap and the performance goes down. In this
case the maximum number is set to 6000
===============================
An Apache process is using around 12MB of RAM. Apache should be configured that
the maximum number of HTTPD processes time 12MB is lower than the amount of
RAM. Otherwise the system begins to swap and the performance goes down. In this
case the maximum number is set to 6000.
KeepAlive should be configured with sensible defaults
-----------------------------------------------------
=====================================================
.. code-block:: apache
@@ -133,11 +223,11 @@ KeepAlive should be configured with sensible defaults
KeepAliveTimeout 2
MaxKeepAliveRequests 10
mod_gzip
--------
mod_gzip should be used because it speeds up the transfer of data and helps to
free server memory and http connections are closed faster.
========
``mod_gzip`` should be used because it speeds up the transfer of data and
helps to free server memory, and HTTP connections are closed faster.
.. Commented out because oC does not support mod_deflate
.. mod_deflate
@@ -145,30 +235,30 @@ free server memory and http connections are closed faster.
.. mod_deflate should be used because it speeds up the transfer of data and helps
.. to free server memory and http connections are closed faster
PHP safe mode
=============
php safe mode
-------------
php safe mode has to be turned off. It is deprecated and will be removed in
PHP safe mode has to be turned off. It is deprecated and will be removed in
newer PHP versions.
MPM
~~~
Apache prefork has to be used. Don’t use threaded mpm with mod_php because php
is currently not thread safe.
===
Apache prefork has to be used. Don’t use threaded ``mpm`` with ``mod_php``
because PHP is currently not thread safe.
Hostname Lookups
----------------
================
.. code-block:: bash
# cat /etc/httpd/conf/httpd.conf
...
HostnameLookups off
...
Log files
---------
=========
Log files should be switched off for maximum performance.
Comment out the `CustomLog`` directive. Keep ``ErrorLog`` to be able to track down errors.
@@ -176,7 +266,7 @@ Comment out the `CustomLog`` directive. Keep ``ErrorLog`` to be able to track do
.. todo: loglevel?
MaxKeepAliveRequests 4096
-------------------------
=========================
.. code-block:: apache
@@ -193,34 +283,58 @@ MaxKeepAliveRequests 4096
Options Indexes SymLinksIfOwnerMatch AllowOverride All
</Directory>
**********************
Database Best Practice
======================
**********************
Currently ownCloud supports the following relational database management systems:
- mysql
- mariadb
- postgresql
- oracle
- mssql
- MySQL
- MariaDB
- PostgreSQL
- SQLite
- Oracle
- Mssql
We are using the `doctrine database abstraction layer`_ and schema evolution with a `MDB2 Schema`_ based table description in XML.
We are using the `doctrine database abstraction layer`_ and schema evolution
with a `MDB2 Schema`_ based table description in XML.
.. _doctrine database abstraction layer: http://www.doctrine-project.org/projects/dbal.html
.. _MDB2 Schema: https://raw2.github.com/pear/MDB2_Schema/master/docs/xml_schema_documentation.html
The default indexes are chosen to support every day usage. Additional indexes might further improve the performance.
The default indexes are chosen to support every day usage. Additional indexes
might further improve the performance.
Using MariaDB/MySQL instead of SQLite
=====================================
MySQL or MariaDB are preferred because of the `performance limitations of
SQLite with highly concurrent applications
<http://www.sqlite.org/whentouse.html>`_, like ownCloud.
On large instances you could consider `running MySQLTuner
<https://github.com/major/MySQLTuner-perl/>`_ to optimize the database.
See the section :doc:`../configuration_database/linux_database_configuration`
how to configure ownCloud for MySQL or MariaDB. If your installation is already
running on
SQLite then it is possible to convert to MySQL or MariaDB using the steps
provided in :doc:`../configuration_database/db_conversion`.
Improve slow performance with MySQL on Windows
==============================================
On Windows hosts running MySQL on the same system changing the parameter
``dbhost`` in your ``config/config.php``
from ``localhost`` to ``127.0.0.1`` could improve the page loading time.
See also `this forum thread
<http://forum.owncloud.org/viewtopic.php?f=17&t=7559>`_.
MySQL / MariaDB
---------------
===============
Usage scenario
~~~~~~~~~~~~~~
Is the recommended setup. Well tested.
Additional Indexes
~~~~~~~~~~~~~~~~~~
Additional indexes may improve performance.
Index on uid in oc_group_user:
@@ -252,79 +366,292 @@ Index on oc_files_trashsize:
create index oc_files_trashsize_user on oc_files_trashsize(user);
Progress of adding them to the default code is tracked in https://github.com/owncloud/core/issues/7474.
Progress of adding them to the default code is tracked in
https://github.com/owncloud/core/issues/7474.
Other performance improvements
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
==============================
Mysql: compare https://tools.percona.com/wizard to your current settings
MariaDB: https://mariadb.com/kb/en/optimization-and-tuning/
Postgresql
----------
==========
Usage scenario
~~~~~~~~~~~~~~
Alternative to mysql. Used in production by a few core developers.
Alternative to MariaDB/MySQL. Used in production by a few core developers.
Migration
~~~~~~~~~
---------
Requires at least Postgresql 9.0
Additional Indexes
~~~~~~~~~~~~~~~~~~
The ones from mysql should work just fine. Progress of adding them to the default code is tracked in https://github.com/owncloud/core/issues/7474.
------------------
The ones from MySQL should work just fine. Progress of adding them to the
default code is tracked in https://github.com/owncloud/core/issues/7474.
Other performance improvements
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
------------------------------
See http://wiki.postgresql.org/wiki/Performance_Optimization
Additional Indexes
~~~~~~~~~~~~~~~~~~
The ones from mysql should work just fine. Progress of adding them to the default code is
tracked in https://github.com/owncloud/core/issues/7474.
Oracle Database
---------------
===============
Usage scenario
~~~~~~~~~~~~~~
Existing enterprise installations. Only core apps are supported and tested. Not recommended because it involves compiling the oci8
Usage scenario: Existing enterprise installations. Only core apps are supported
and tested. Not recommended because it involves compiling the oci8
Additional Indexes
~~~~~~~~~~~~~~~~~~
The ones from mysql should work just fine. Progress of adding them to the default code is tracked in https://github.com/owncloud/core/issues/7474.
------------------
The ones from mysql should work just fine. Progress of adding them to the
default code is tracked in https://github.com/owncloud/core/issues/7474.
Other performance improvements
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
------------------------------
http://de.slideshare.net/cjorcl/best-practices-php-and-the-oracle-database and ask your DBA.
Problems
~~~~~~~~
--------
When ORA-56600 occurs (Oracle Bug 8467564) set this php.ini setting:
`oci8.statement_cache_size=1000`, see `oracle forum discussion`_
.. _oracle forum discussion: https://community.oracle.com/message/3468020#3468020
Microsoft SQL Server
--------------------
====================
Usage scenario
~~~~~~~~~~~~~~
Only core apps are supported. **Not** even tested by jenkins.
Usage scenario: Only core apps are supported. **Not** even tested by Jenkins.
Additional Indexes
~~~~~~~~~~~~~~~~~~
------------------
The ones from mysql should work just fine. Progress of adding them to the default code is tracked in https://github.com/owncloud/core/issues/7474.
Other performance improvements
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
------------------------------
http://www.mssqltips.com/sql-server-tip-category/9/performance-tuning/
*******************************************************************
Nginx: caching ownCloud gallery thumbnails with fastcgi_cache_purge
*******************************************************************
One of the optimisations for ownCloud when using Nginx as webserver is to
combine FastCGI caching with "Cache Purge", a `3rdparty Nginx module
<http://wiki.nginx.org/3rdPartyModules>`_ that adds the ability to purge
content from `FastCGI`, `proxy`, `SCGI` and `uWSGI` caches. This mechanism
speeds up thumbnail presentation as it shifts requests to Nginx and minimizes
php invocations which else would take place for every thumbnail presented every
time.
The following procedure is based on an Ubuntu 14.04 system. You may need to
adapt it according your OS type and release.
.. note::
Unlike Apache, Nginx does not dynamically load modules. All modules needed,
must be compiled into Nginx. This is one of the reasons for Nginx´s
performance. It is expected to have an already running Nginx installation
with a working configuration set up like described in the ownCloud
documentation.
Nginx module check
==================
As a first step, it is necessary to check if your Nginx installation has the
``nginx cache purge`` module compiled in::
nginx -V 2>&1 | grep ngx_cache_purge -o
If your output contains ``ngx_cache_purge``, you can continue with the
configuration, else you need to manually compile Nginx with the module needed.
Compile Nginx with the ``nginx-cache-purge`` module
===================================================
1. **Preparation:**
.. code-block:: bash
cd /opt
wget http://nginx.org/keys/nginx_signing.key
sudo apt-key add nginx_signing.key
sudo vi /etc/apt/sources.list.d/nginx.list
Add following lines (in case, replace ``{trusty}`` by your distribution
name)::
deb http://nginx.org/packages/mainline/ubuntu/ trusty nginx``
deb -src http://nginx.org/packages/mainline/ubuntu/ trusty nginx``
Then run ``sudo apt-get update``
.. note:: If you're not overly cautious and wish to install the latest and
greatest Nginx packages and features, you may have to install Nginx from its
mainline repository. From the Nginx homepage: "In general, you should
deploy Nginx from its mainline branch at all times." If you would like to
use standard Nginx from the latest mainline branch but without compiling in
any additional modules, just run ``sudo apt-get install nginx``.
2. **Download the Nginx source from the ppa repository**
.. code-block:: bash
cd /opt
sudo apt-get build-dep nginx
sudo apt-get source nginx`
3. **Download module(s) to be compiled in and configure compiler arguments**
.. code-block:: bash
ls -la
Please replace ``{release}`` with the release downloaded::
cd /opt/nginx-{release}/debian
If folder "modules" is not present, do:
.. code-block:: bash
sudo mkdir modules
cd modules
sudo git clone https://github.com/FRiCKLE/ngx_cache_purge.git
sudo vi /opt/nginx-{release}/debian/rules
If not present, add the following line at the top under::
#export DH_VERBOSE=1:
MODULESDIR = $(CURDIR)/debian/modules
And the end of every ``./configure`` command add::
--add-module=$(MODULESDIR)/ngx_cache_purge
Don't forget to escape preceeding lines with a backslash ``\``.
The parameters may now look::
$(WITH_SPDY) \
--with-cc-opt="$(CFLAGS)" \
--with-ld-opt="$(LDFLAGS)" \
--with-ipv6 \
--add-module=$(MODULESDIR)/ngx_cache_purge
4. **Compile and install Nginx**
.. code-block:: bash
cd /opt/nginx-{release}
sudo dpkg-buildpackage -uc -b
ls -la /opt
sudo dpkg --install /opt/nginx_{release}~{distribution}_amd64.deb
5. **Check if the compilation and installation of the ngx_cache_purge module
was successful**
.. code-block:: bash
nginx -V 2>&1 grep ngx_cache_purge -o``
It should show now: ``ngx_cache_purge``
Show Nginx version including all features compiled and installed::
nginx -V 2>&1 sed s/" --"/"\n\t--"/g
6. **Mark Nginx to be blocked from further updates via apt-get**
.. code-block:: bash
sudo dpkg --get-selections grep nginx
For every nginx component listed run ``sudo apt-mark hold <component>``
7. **Regular checks for nginx updates**
Do a regular visit on the `Nginx news page <http://nginx.org>`_ and proceed
in case of updates with item 2 to 5.
Configure Nginx with the ``nginx-cache-purge`` module
=====================================================
1. **Preparation**
Create a directory where Nginx will save the cached thumbnails. Use any
path that fits to your environment. Replace ``{path}`` in this example with
your file path:
.. code-block:: bash
sudo mkdir -p /usr/local/tmp/cache
2. **Configuration**
.. code-block:: bash
sudo vi /etc/nginx/sites-enabled/{your-ownCloud-nginx-config-file}``
Add at the *beginning*, but *outside* the ``server{}`` block::
fastcgi_cache_path {path} levels=1:2 keys_zone=OWNCLOUD:100m
inactive=60m;
Add *inside* the ``server{}`` block, as an example of a configuration::
set $skip_cache 1;
# POST requests and urls with a query string should always go to PHP
if ($request_uri ~* "thumbnail.php")
{ set $skip_cache 0;
}
fastcgi_cache_key "$scheme$request_method$host$request_uri";
fastcgi_cache_use_stale error timeout invalid_header http_500;
fastcgi_ignore_headers Cache-Control Expires Set-Cookie;
location ~ \.php(?:$/) {
fastcgi_split_path_info ^(.+\.php)(/.+)$;
include fastcgi_params;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
fastcgi_param PATH_INFO $fastcgi_path_info;
fastcgi_param HTTPS on;
fastcgi_pass php-handler;
fastcgi_cache_bypass $skip_cache;
fastcgi_no_cache $skip_cache;
fastcgi_cache OWNCLOUD;
fastcgi_cache_valid 60m;
}
.. note: Note regarding the ``fastcgi_pass`` parameter:
Use whatever fits your configuration. In the example above, a ``upstream``
was defined in an Nginx global configuration file.
This then can look like::
upstream php-handler {
server 127.0.0.1:9000;
# or
#server unix:/var/run/php5-fpm.sock;
}
3. **Test the configuration**
.. code-block:: bash
sudo service nginx restart
* Open your browser and clear your cache.
* Logon to your ownCloud instance, open the gallery app, move thru your
folders and watch while the thumbnails are generated for the first time.
* You may also watch with eg. ``htop`` your system load while the
thumbnails are processed.
* Go to another app or logout and relogon.
* Open the gallery app again and browse to the folders you accessed before.
Your thumbnails should appear more or less immediately.
* ``htop`` will not show up additional load while processing, compared to
the high load before.