diff --git a/admin_manual/configuration_files/files_locking_experimental.rst b/admin_manual/configuration_files/files_locking_experimental.rst new file mode 100644 index 000000000..cb59013d1 --- /dev/null +++ b/admin_manual/configuration_files/files_locking_experimental.rst @@ -0,0 +1,55 @@ +========================= +Experimental File Locking +========================= + +ownCloud's new experimental file locking mechanism operates differently than +the old File Locking application, and will eventually replace it. If you elect +to use the new file locking mechanism make sure you disable the File Locking +app. + +The new file locking mechanism has these capabilities: + +* Operates at a higher level than the filesystem, so you don't need to use a + filesystem that supports locking +* Locks parent directories so they cannot be renamed during any activity on + files inside the directories +* Releases locks after file transactions are interrupted, for + example when a sync client loses the connection during an upload +* Manage locking and releasing locks correctly on shared files during changes + from multiple users +* Manages locks correctly on external storage mounts +* Manages encrypted files correctly + +You must install the ``php-redis`` module for the new file locking to work. On +Debian/Ubuntu/Mint this is ``php5-redis``, and on Red Hat/CentOS/Fedora is it +``php-pecl-redis`` in the EPEL repository. + +We recommend using `Redis `_ as your ownCloud memcache when +you enable file locking. Memcached, the popular distributed memory caching +system, is not suitable for the new file locking because it is not designed to +store locks, and data can disappear from the cache at any time. Redis is a +key-value store, and it guarantees that cached objects are available for as +long as they are needed. Redis is available on most Linux distributions, and +requires a simple configuration in your ``config.php`` file, like this example:: + + 'filelocking.enabled' => 'true', + 'memcache.local' => '\\OC\\Memcache\\Redis', + 'redis' => array( + 'host' => 'localhost', + // can also be a unix domain socket: + '/tmp/redis.sock' + 'port' => 6379, + 'timeout' => 0.0, + // Optional, if undefined SELECT will not run and will use Redis + // Server's default DB Index. + 'dbindex' => 0, + ), + +The **Server status** section on your ownCloud Admin page indicates whether +experimental file locking is enabled or disabled, and if it is configured +correctly. + +.. figure:: ../images/file-lock-status.png + +See ``config.sample.php`` to see configuration examples for Redis, and for all +supported memcaches. diff --git a/admin_manual/configuration_files/index.rst b/admin_manual/configuration_files/index.rst index a07840415..751f213a5 100644 --- a/admin_manual/configuration_files/index.rst +++ b/admin_manual/configuration_files/index.rst @@ -6,15 +6,16 @@ File Sharing and Management .. toctree:: :maxdepth: 2 - file_sharing_configuration.rst - big_file_upload_configuration.rst + file_sharing_configuration + big_file_upload_configuration collaborative_documents_configuration - default_files_configuration.rst + default_files_configuration external_storage_configuration_gui external_storage_configuration - encryption_configuration.rst - files_locking_enabling.rst - federated_cloud_sharing_configuration.rst + encryption_configuration + files_locking_enabling + files_locking_experimental + federated_cloud_sharing_configuration previews_configuration serving_static_files_configuration \ No newline at end of file diff --git a/admin_manual/images/file-lock-status.png b/admin_manual/images/file-lock-status.png new file mode 100644 index 000000000..ad5676feb Binary files /dev/null and b/admin_manual/images/file-lock-status.png differ