khanh.pndc/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-01-02 17:59:36 +07:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' into firewall

Browse Source 
Conflicts:
	admin_manual/contents.rst
This commit is contained in:
Carla Schroder
2015-11-09 09:58:57 -08:00
parent 250dd8cbfd bb0aa5f7e4
commit 7d203d9bac
63 changed files with 1043 additions and 726 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
README.rst
View File

@@ -20,7 +20,7 @@ This repository hosts three manuals:
* **Administration Manual**
* **Developers Manual**
Please work in the appropriate branch. stable6 is for ownCloud 6, stable7 is for ownCloud 7, stable8 is 8.0, stable8.1 is 8.1, and master is version 8.2.
Please work in the appropriate branch. Stable7 is for ownCloud 7, stable8 is 8.0, stable8.1 is 8.1, stable8.2 is 8.2, and master is version 9.
Please wrap lines at 80 characters.
@@ -34,6 +34,7 @@ As this grows it may be moved to its own page.
* ownCloud Apps Store
* synchronize
* Web (Web page, Web site)
License
-------

3
_shared_assets/themes/owncloud_org/layout.html
View File

@@ -111,6 +111,9 @@
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="theme-color" content="#1d2d44">
<link rel="shortcut icon" href="https://owncloud.org/wp-content/themes/owncloudorgnew/assets/img/common/favicon.png" />
<link rel="apple-touch-icon-precomposed" href="https://owncloud.org/wp-content/themes/owncloudorgnew/assets/img/common/favicon.png" />
{% endblock %}
{# Silence the sidebar's, relbar's #}

4
admin_manual/conf.py
View File

@@ -49,9 +49,9 @@ copyright = u'2012-2015, The ownCloud developers'
# built documents.
#
# The short X.Y version.
version = '8.2'
version = '9.0'
# The full version, including alpha/beta/rc tags.
release = '8.2'
release = '9.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.

31
admin_manual/configuration_database/linux_database_configuration.rst
View File

@@ -17,6 +17,37 @@ Choosing to use MySQL / MariaDB, PostgreSQL, or Oracle as your database requires
.. note:: The steps for configuring a third party database are beyond the scope of this document. Please refer to the documentation for your specific database choice for instructions.
.. _db-binlog-label:
MySQL / MariaDB with Binary Logging Enabled
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
ownCloud is currently using a ``TRANSACTION_READ_COMMITTED`` transaction isolation
to avoid data loss under high load scenarios (e.g. by using the sync client with
many clients/users and many parallel operations). This requires a disabled or
correctly configured binary logging when using MySQL or MariaDB. Your system is
affected if you see the following in your log file during the installation or
update of ownCloud:
An unhandled exception has been thrown:
exception 'PDOException' with message 'SQLSTATE[HY000]: General error: 1665
Cannot execute statement: impossible to write to binary log since
BINLOG_FORMAT = STATEMENT and at least one table uses a storage engine limited
to row-based logging. InnoDB is limited to row-logging when transaction
isolation level is READ COMMITTED or READ UNCOMMITTED.'
There are two solutions. One is to disable binary logging. Binary logging
records all changes to your database, and how long each change took. The
purpose of binary logging is to enable replication and to support backup
operations.
The other is to change the BINLOG_FORMAT = STATEMENT in your database
configuration file, or possibly in your database startup script, to
BINLOG_FORMAT = MIXED. See `Overview of the Binary
Log <https://mariadb.com/kb/en/mariadb/overview-of-the-binary-log/>`_ and `The
Binary Log <https://dev.mysql.com/doc/refman/5.6/en/binary-log.html>`_ for
detailed information.
Parameters
----------
For setting up ownCloud to use any database, use the instructions in :doc:`../installation/installation_wizard`. You should not have to edit the respective values in the :file:`config/config.php`. However, in special cases (for example, if you want to connect your ownCloud instance to a database created by a previous installation of ownCloud), some modification might be required.

2
admin_manual/configuration_files/big_file_upload_configuration.rst
View File

@@ -10,7 +10,7 @@ hard limits that cannot be exceeded:
* < 2GB on Windows (32Bit and 64Bit)
* < 2GB with Server Version 4.5 or older
* < 2GB with IE6 - IE8
* < 4GB with IE9 - IE10
* < 4GB with IE9 - IE11
64-bit filesystems have much higher limits; consult the documentation for your
filesystem.

123
admin_manual/configuration_files/encryption_configuration.rst
View File

@@ -3,30 +3,28 @@ Encryption Configuration
========================
If you are upgrading from ownCloud 8.0, and have encryption enabled, please see
:ref:`upgrading` (below) for the correct steps to upgrade your encryption.
:ref:`upgrading_encryption_label` (below) for the correct steps to upgrade your
encryption.
In ownCloud 8.1 and up the server-side encryption has a number of changes and
The primary purpose of the ownCloud server-side encryption is to protect users'
files on remote storage, such as Dropbox and Google Drive, and to do it easily
and seamlessly from within ownCloud.
In ownCloud 8.2 the server-side encryption has a number of changes and
improvements, including:
* When encryption is enabled, all files are no longer encrypted at user's first
logins because this causes timeouts on large installations. Instead, only
files that are created or updated after encryption has been enabled are
encrypted.
* The "decrypt all" option in the Personal settings has been removed, also for
performance reasons.
* A new option for users to enable/disable encryption on a per mount-point
basis.
* The option to choose from multiple encryption modules.
* An option to create a master encryption key, which replaces all individual
user keys. This is especially useful for single-sign on.
* Encrypt all data files at once when enabling encryption.
* Decrypt all data files, or per user.
* Users may decrypt their own files.
* Move your keys to a different folder.
ownCloud server-side encryption encrypts files stored on the ownCloud server,
and files on remote storage that is connected to your ownCloud server.
Encryption and decryption are performed on the ownCloud server. All files sent
to remote storage (for example Dropbox and Google Drive) will be encrypted by
the ownCloud server, and upon retrieval, decrypted before serving them to you
and anyone you have shared them with.
to remote storage will be encrypted by the ownCloud server, and upon retrieval,
decrypted before serving them to you and anyone you have shared them with.
.. note:: Encrypting files increases their size by roughly 35%, so you must
take this into account when you are provisioning storage and setting
@@ -37,10 +35,6 @@ When files on external storage are encrypted in ownCloud, you cannot share them
directly from the external storage services, but only through ownCloud sharing
because the key to decrypt the data never leaves the ownCloud server.
The main purpose of the ownCloud server-side encryption is to protect users'
files on remote storage, and to do it easily and seamlessly from within
ownCloud.
ownCloud's server-side encryption generates a strong encryption key, which is
unlocked by user's passwords. Your users don't need to track an extra
password, but simply log in as they normally do. It encrypts only the contents
@@ -81,17 +75,19 @@ storage.
Before Enabling Encryption
--------------------------
Plan very carefully before enabling encryption because **it is not
reversible**, and if you lose your encryption keys your files are not
Plan very carefully before enabling encryption because it is not reversible via
the ownCloud Web interface. If you lose your encryption keys your files are not
recoverable. Always have backups of your encryption keys stored in a safe
location, and consider enabling all recovery options.
.. _enable_encryption:
You have more options via the ``occ`` command (see :ref:`occ_encryption_label`)
.. _enable_encryption_label:
Enabling Encryption
-------------------
ownCloud encryption now consists of two parts. The base encryption system is
ownCloud encryption consists of two parts. The base encryption system is
enabled and disabled on your Admin page. First you must enable this, and then
select an encryption module to load. Currently the only available encryption
module is the ownCloud Default Encryption Module.
@@ -169,10 +165,14 @@ You may change your Recovery Key password.
.. figure:: ../images/encryption12.png
.. _occ_encryption_label:
occ Encryption Commands
-----------------------
You may also use the ``occ`` command to perform encryption operations.
If you have shell access you may use the ``occ`` command to perform encryption
operations, and you have additional options such as decryption and creating a
single master encryption key.
Get the current status of encryption and the loaded encryption module::
@@ -191,18 +191,46 @@ Select a different default Encryption module::
occ encryption:set-default-module [Module ID].
The [module ID] is taken from the ``encryption:list-modules`` command.
The [module ID] is taken from the ``encryption:list-modules`` command.
Encrypt all data files for all users. For performance reasons, when you enable
encryption on an ownCloud server only new and changed files are encrypted. This
command gives you the option to encrypt all files. You must first put your
ownCloud server into single-user mode to prevent any user activity until
encryption is completed::
occ encryption:encrypt-all
Decrypt all user data files, or optionally a single user::
See :doc:`../configuration_server/occ_command` for detailed instructions on
using ``occ``.
occ encryption:decrypt-all [username]
Move keys to a different folder, either locally or on a different server::
occ encryption:change-key-storage-root
View current location of keys::
occ encryption:show-key-storage-root
Create a new master key. Use this when you have a single-sign on
infrastructure. Use this only on fresh installations with no existing data, or
on systems where encryption has not already been enabled. It is not possible to
disable it::
occ encryption:enable-master-key
See :ref:`encryption_label` for detailed instructions on using ``occ``.
Files Not Encrypted
-------------------
Only the data in your files is encrypted, and not the filenames or folder
structures. These files are never encrypted:
Only the data in the files in ``data/user/files`` is encrypted, and not the
filenames or folder structures. These files are never encrypted:
- Old files in the trash bin
- Existing files in the trash bin & Versions. Only new and changed files after
encryption is enabled are encrypted.
- Existing files in Versions
- Image thumbnails from the Gallery app
- Previews from the Files app
- The search index from the full text search app
@@ -222,7 +250,7 @@ Key then you can change a user's password in the ownCloud Users panel to match
their back-end password, and then, of course, notify the user and give them
their new password.
.. _upgrading:
.. _upgrading_encryption_label:
Upgrading From ownCloud 8.0
---------------------------
@@ -236,7 +264,7 @@ Before you start your upgrade, put your ownCloud server into
You must do this to prevent users and sync clients from accessing files before
you have completed your encryption migration.
After your upgrade is complete, follow the steps in :ref:`enable_encryption` to
After your upgrade is complete, follow the steps in :ref:`enable_encryption_label` to
enable the new encryption system. Then click the **Start Migration** button on
your Admin page to migrate your encryption keys, or use the ``occ`` command. We
strongly recommend using the ``occ`` command; the **Start Migration** button is
@@ -327,28 +355,5 @@ File keys for files owned by the user:
Share keys for files owned by the user (one key for the owner and one key for each user with access to the file):
:file:`data/<user>/files_encryption/keys/<file_path>/<filename>/OC_DEFAULT_MODULE/<user>.shareKey`
.. This section commented out because there is no windows support
.. in oC8; un-comment this if windows support is restored
.. "Missing requirements" Message on Windows Servers
.. --------------------------------------------------
.. If you get a "Missing requirements" error message when you enable encryption
.. on a Windows server, enter the absolute location of your openSSL
.. configuration file in ``config.php``::
.. 'openssl' => array(
.. 'config' => 'C:\path\to\openssl.cnf',
.. ),
.. For example, in a typical installation on a 64-bit Windows 7 system it looks
.. like this::
.. 'openssl' => array(
.. 'config' => 'C:\OpenSSL-Win64\openssl.cnf',
.. ),
.. There are many ways to configure OpenSSL, so be sure to verify your correct
.. file location.
.. references -- https://github.com/owncloud/QA/issues/16
..

4
admin_manual/configuration_files/external_storage/local.rst
View File

@@ -15,8 +15,8 @@ are on Ubuntu Linux::
sudo -u www-data chown -R www-data:www-data /localdir
sudo -u www-data chmod -R 0750 /localdir
See :ref:`label-setting-strong-perms` for information on correct file permissions,
and find your HTTP user :ref:`label-phpinfo`.
See :ref:`strong_perms_label` for information on correct file permissions, and
find your HTTP user :ref:`label-phpinfo`.
In the **Folder name** field enter the folder name that you want to appear on
your ownCloud Files page.

25
admin_manual/configuration_files/files_locking_transactional.rst
View File

@@ -5,7 +5,7 @@ Transactional File Locking
ownCloud's new transactional file locking mechanism operates differently than
the old File Locking application, and will eventually replace it. The purpose
of this mechanism is to avoid file corruption during normal operation. If you
select to use the new file locking mechanism make sure you disable the File
elect to use the new file locking mechanism make sure you disable the File
Locking app.
The new file locking mechanism has these capabilities:
@@ -33,14 +33,29 @@ file like this example::
'host' => 'localhost',
'port' => 6379,
'timeout' => 0.0,
'password' => '', // Optional, if not defined no password will be used.
),
The **Server status** section on your ownCloud Admin page indicates whether
experimental file locking is enabled or disabled.
.. note:: For enhanced security it is recommended to configure Redis to require
a password. See http://redis.io/topics/security for more information.
.. figure:: ../images/transactional-locking-1.png
If you want to connect to Redis configured to listen on an unix socket (which is
recommended if Redis is running on the same system as ownCloud) use this example
``config.php`` configuration::
.. figure:: ../images/transactional-locking-2.png
'filelocking.enabled' => 'true',
'memcache.locking' => '\OC\Memcache\Redis',
'redis' => array(
'host' => '/var/run/redis/redis.sock',
'port' => 0,
'timeout' => 0.0,
),
.. note:: Large installations especially benefit from setting
``memcache.locking``. File locking is enabled by default, which uses the
database locking backend. This places a significant load on your database.
Using ``memcache.locking`` relieves the database load and improves
performance.
See ``config.sample.php`` to see configuration examples for Redis, and for all
supported memcaches.

20
admin_manual/configuration_server/caching_configuration.rst
View File

@@ -177,11 +177,29 @@ Redis for the local server cache::
'redis' => array(
'host' => 'localhost',
'port' => 6379,
'timeout' => 0.0,
'password' => '', // Optional, if not defined no password will be used.
),
.. note:: For enhanced security it is recommended to configure Redis to require
a password. See http://redis.io/topics/security for more information.
If you want to connect to Redis configured to listen on an unix socket (which is
recommended if Redis is running on the same system as ownCloud) use this example
``config.php`` configuration::
'memcache.local' => '\OC\Memcache\Redis',
'redis' => array(
'host' => '/var/run/redis/redis.sock',
'port' => 0,
'timeout' => 0.0,
),
Redis is very configurable; consult `the Redis documentation
<http://redis.io/documentation>`_ to learn more.
<http://redis.io/documentation>`_ to learn more.
If you are on Ubuntu you can follow `this guide
<https://www.en0ch.se/how-to-configure-redis-cache-in-ubuntu-14-04-with-owncloud/>`_ for a complete installation from scratch.
Cache Directory Location
------------------------

98
admin_manual/configuration_server/config_sample_php_parameters.rst
View File

@@ -54,13 +54,6 @@ installer. (There are also per-user salts.) If you lose this salt you lose
all your passwords. This example is for documentation only, and you should
never use it.
::
'hashingCost' => 10,
The hashing cost used by hashes generated by ownCloud
Using a higher value requires more time and CPU power to calculate the hashes
::
'trusted_domains' =>
@@ -82,17 +75,6 @@ directory. The SQLite database is also stored here, when you use SQLite.
(SQLite is not available in ownCloud Enterprise Edition)
::
'tempdirectory' => '/tmp/owncloudtemp',
Override where ownCloud stores temporary files. Useful in situations where
the system temporary directory is on a limited space ramdisk or is otherwise
restricted, or if external storages which do not support streaming are in
use.
The web server user must have write access to this directory.
::
'version' => '',
@@ -150,22 +132,6 @@ you shouldn't need to change it.
Prefix for the ownCloud tables in the database.
::
'dbdriveroptions' => array(
PDO::MYSQL_ATTR_SSL_CA => '/file/path/to/ca_cert.pem',
),
Additional driver options for the database connection, eg. to enable SSL
encryption in MySQL.
::
'sqlite.journal_mode' => 'DELETE',
sqlite3 journal mode can be specified using this config parameter - can be
'WAL' or 'DELETE' see for more details https://www.sqlite.org/wal.html
::
'installed' => false,
@@ -173,6 +139,7 @@ sqlite3 journal mode can be specified using this config parameter - can be
Indicates whether the ownCloud instance was installed successfully; ``true``
indicates a successful installation, and ``false`` indicates an unsuccessful
installation.
.. DEFAULT_SECTION_END
.. Generated content above. Don't change this.
@@ -657,6 +624,16 @@ Defaults to ``[datadirectory]/owncloud.log``
Loglevel to start logging at. Valid values are: 0 = Debug, 1 = Info, 2 =
Warning, 3 = Error, and 4 = Fatal. The default value is Warning.
::
'syslog_tag' => 'ownCloud',
If you maintain different instances and aggregate the logs, you may want
to distinguish between them. ``syslog_tag`` can be set per instance
with a unique id. Only available if ``log_type`` is set to ``syslog``.
The default value is ``ownCloud``.
::
'log.condition' => [
@@ -1059,11 +1036,16 @@ Memory caching backend for distributed data
'host' => 'localhost', // can also be a unix domain socket: '/tmp/redis.sock'
'port' => 6379,
'timeout' => 0.0,
'password' => '', // Optional, if not defined no password will be used.
'dbindex' => 0, // Optional, if undefined SELECT will not run and will use Redis Server's default DB Index.
),
Connection details for redis to use for memory caching.
For enhanced security it is recommended to configure Redis
to require a password. See http://redis.io/topics/security
for more information.
::
'memcached_servers' => array(
@@ -1131,6 +1113,26 @@ to be fetched in addition to any requested file.
One way to test is applying for a trystack account at http://trystack.org/
All other config options
------------------------
::
'dbdriveroptions' => array(
PDO::MYSQL_ATTR_SSL_CA => '/file/path/to/ca_cert.pem',
),
Additional driver options for the database connection, eg. to enable SSL
encryption in MySQL.
::
'sqlite.journal_mode' => 'DELETE',
sqlite3 journal mode can be specified using this config parameter - can be
'WAL' or 'DELETE' see for more details https://www.sqlite.org/wal.html
::
'supportedDatabases' => array(
@@ -1148,9 +1150,23 @@ Available:
- pgsql (PostgreSQL)
- oci (Oracle - Enterprise Edition Only)
All other config options
------------------------
::
'tempdirectory' => '/tmp/owncloudtemp',
Override where ownCloud stores temporary files. Useful in situations where
the system temporary directory is on a limited space ramdisk or is otherwise
restricted, or if external storages which do not support streaming are in
use.
The web server user must have write access to this directory.
::
'hashingCost' => 10,
The hashing cost used by hashes generated by ownCloud
Using a higher value requires more time and CPU power to calculate the hashes
::
@@ -1324,16 +1340,6 @@ Set this ownCloud instance to debugging mode
Only enable this for local development and not in production environments
This will disable the minifier and outputs some additional debug information
::
'update.skip-migration-test' => false,
Skips the migration test during upgrades
If this is set to true the migration test are deactivated during upgrade.
This is only recommended in installations where upgrade tests are run in
advance with the same data on a test system.
::
'copied_sample_config' => true,

428
admin_manual/configuration_server/occ_command.rst
View File

@@ -3,43 +3,53 @@ Using the occ Command
=====================
ownCloud's ``occ`` command (ownCloud console) is ownCloud's command-line
interface. You can perform many common server operations with ``occ``::
* Manage apps
* Manage users
* Reset passwords, including administrator passwords
* Convert the ownCloud database from SQLite to a more performant DB
* Query and change LDAP settings
interface. You can perform many common server operations with ``occ``, such as installing and upgrading ownCloud, manage users, encryption, passwords, and LDAP setting, and more.
``occ`` is in the :file:`owncloud/` directory; for example
:file:`/var/www/owncloud` on Ubuntu Linux. ``occ`` is a PHP script. You must run
it as your HTTP user to ensure that the correct permissions are maintained on
your ownCloud files and directories.
.. _http_user:
occ Command Directory
---------------------
* :ref:`http_user_label`
* :ref:`apps_commands_label`
* :ref:`background_jobs_selector_label`
* :ref:`config_commands_label`
* :ref:`database_conversion_label`
* :ref:`encryption_label`
* :ref:`file_operations_label`
* :ref:`create_javascript_translation_files_label`
* :ref:`ldap_commands_label`
* :ref:`logging_commands_label`
* :ref:`maintenance_commands_label`
* :ref:`user_commands_label`
* :ref:`command_line_installation_label`
* :ref:`command_line_upgrade_label`
.. _http_user_label:
Run occ As Your HTTP User
-------------------------
The HTTP user is different on the various Linux distributions. See
:ref:`strong_perms` to learn how to find your HTTP user.
:ref:`strong_perms_label` to learn how to find your HTTP user.
* The HTTP user and group in Debian/Ubuntu is www-data.
* The HTTP user and group in Fedora/CentOS is apache.
* The HTTP user and group in Arch Linux is http.
* The HTTP user in openSUSE is wwwrun, and the HTTP group is www.
If your HTTP server is configured to use a different php version than the default (/usr/bin/php), occ should be run with the same version. Example: In CentOS 6.5 with SCL-PHP54 installed, the command looks like this::
If your HTTP server is configured to use a different PHP version than the default (/usr/bin/php), ``occ`` should be run with the same version. Example: In CentOS 6.5 with SCL-PHP54 installed, the command looks like this::
$ sudo -u apache /opt/rh/php54/root/usr/bin/php /var/www/html/owncloud/occ ...
Running it with no options lists all commands and options, like this example on
Ubuntu::
$ sudo -u www-data php occ
ownCloud version 8.1
ownCloud version 8.2
Usage:
[options] command [arguments]
@@ -70,14 +80,14 @@ Run it with the ``-h`` option for syntax help::
Display your ownCloud version::
$ sudo -u www-data php occ -V
ownCloud version 8.1
ownCloud version 8.2
Query your ownCloud server status::
$ sudo -u www-data php occ status
- installed: true
- version: 8.1.0.4
- versionstring: 8.1 alpha 3
- version: 8.2.0.9
- versionstring: 8.2
- edition:
``occ`` has options, commands, and arguments. Options and arguments are
@@ -107,17 +117,17 @@ this example for the ``maintenance:mode`` command::
The ``status`` command from above has an option to define the output format.
Default is plain text, but it can also be ``json``::
$ sudo -u www-data php status --output json
{"installed":true,"version":"8.1.0.4","versionstring":"8.1 alpha 3",
$ sudo -u www-data php status --output =json
{"installed":true,"version":"8.2.0.9","versionstring":"8.2",
"edition":"Enterprise"}
or ``json_pretty``::
$ sudo -u www-data php status --output json_pretty
$ sudo -u www-data php status --output =json_pretty
{
"installed": true,
"version": "8.1.0.4",
"versionstring": "8.1 alpha 3",
"version": "8.2.0.9",
"versionstring": "8.2",
"edition": "Enterprise"
}
@@ -125,10 +135,12 @@ This ``output`` option is available on all list and list-like commands:
``status``, ``check``, ``app:list``, ``encryption:status``
and ``encryption:list-modules``
.. _apps_commands_label:
Apps Commands
-------------
The ``app`` commands list, enable, and disable apps. This lists all of your
The ``app`` commands list, enable, and disable apps. This example lists all of your
installed apps, and shows whether they are enabled or disabled::
$ sudo -u www-data php occ app:list
@@ -138,23 +150,29 @@ Enable an app::
$ sudo -u www-data php occ app:enable external
external enabled
``app:check-code`` checks if the app uses ownCloud's public API (``OCP``) or
private API (``OC_``). If the app uses the private API it will print a
warning::
$ sudo -u www-data php occ app:check-code activity
[snip]
Analysing /var/www/owncloud/apps/activity/extension/files_sharing.php
0 errors
Analysing /var/www/owncloud/apps/activity/extension/files.php
0 errors
App is not compliant
Disable an app::
$ sudo -u www-data php occ app:disable external
external disabled
``app:check-code`` has multiple checks: it checks if an app uses ownCloud's public API (``OCP``) or private API (``OC_``), and it also checks for deprecated methods and the validity of the ``info.xml`` file. By default all checks are enabled. The Activity app is an example of a correctly-formatted app::
$ sudo -u www-data php occ app:check-code activity
App is compliant - awesome job!
If your app has issues, you'll see output like this::
$ sudo -u www-data php occ app:check-code foo_app
Analysing /opt/owncloud/apps/foo_app/events/event/ruleevent.php
1 errors
line 33: OC_L10N - private class must not be instantiated
Analysing /opt/owncloud/apps/foo_app/events/listeners/failurelistener.php
1 errors
line 46: OC_User - Static method of private class must not be called
PHP Fatal error: Call to undefined method PhpParser\Node\Expr\Variable::toString() in /opt/owncloud/lib/private/app/codechecker/nodevisitor.php on line 171
.. _background_jobs_selector_label:
Background Jobs Selector
------------------------
@@ -174,22 +192,23 @@ The other two commands are:
See :doc:`../configuration_server/background_jobs_configuration` to learn more.
.. _config_commands_label:
Config Commands
---------------
The ``config`` commands can be used to configure the ownCloud server. It is
possible to list all config values with one command::
The ``config`` commands are used to configure the ownCloud server. You can list all configuration values with one command::
$ sudo -u www-data php occ config:list
By default passwords and other sensitive data are omitted from the report, so the
output can be posted publicly (e.g. as part of a bug report). In order to
generate a full backport of all config values the ``--private`` flag needs to be
generate a full backport of all configuration values the ``--private`` flag needs to be
set::
$ sudo -u www-data php occ config:list --private
The exported content can also be imported again to allow the fast set up of
The exported content can also be imported again to allow the fast setup of
similar instances. The import command will only add/update values. Values that
exist in the current configuration, but not in the one that is being imported
are left untouched::
@@ -207,10 +226,10 @@ It is also possible to import remote files, by piping the input::
directly. Use the ``occ app:enable``, ``occ app:disable`` and ``occ update``
commands instead.
Getting a single config value
+++++++++++++++++++++++++++++
Getting a Single Configuration Value
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
There are also commands to get the value of a single app or system config::
These commands get the value of a single app and system configuration::
$ sudo -u www-data php occ config:system:get version
8.2.0.2
@@ -219,10 +238,10 @@ There are also commands to get the value of a single app or system config::
2.1.0
Setting a single config value
+++++++++++++++++++++++++++++
Setting a Single Configuration Value
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
There are also commands to get the value of a single app or system config::
These commands get the value of a single app or system configuration::
$ sudo -u www-data php /occ config:system:set logtimezone --value="Europe/Berlin"
System config value logtimezone set to Europe/Berlin
@@ -230,17 +249,15 @@ There are also commands to get the value of a single app or system config::
$ sudo -u www-data php occ config:app:set files_sharing incoming_server2server_share_enabled --value="yes"
Config value incoming_server2server_share_enabled for app files_sharing set to yes
The set command will create the value, when it did not exist before. If you only
want to update the value, you can set the ``--update-only``::
The ``set`` command creates the value, if it does not already exist. To update the value, set ``--update-only``::
$ sudo -u www-data php occ config:system:set doesnotexist --value="true" --update-only
Value not updated, as it has not been set before.
Deleting a Single Configuration Value
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Deleting a single config value
++++++++++++++++++++++++++++++
There are also commands to delete a config of an app or system config::
These commands delete the configuration of an app or system configuration::
$ sudo -u www-data php occ config:system:delete doesnotexistanymore
System config value doesnotexistanymore deleted
@@ -248,14 +265,15 @@ There are also commands to delete a config of an app or system config::
$ sudo -u www-data php occ config:app:delete appname doesnotexistanymore
Config value doesnotexistanymore of app appname deleted
The delete command will by default not complain if the config was not set
The delete command will by default not complain if the configuration was not set
before. If you want to be notified in that case, set the
``--error-if-not-exists`` flag::
$ sudo -u www-data php occ config:system:delete doesnotexist --error-if-not-exists
System config doesnotexist could not be deleted because it did not exist
.. _database_conversion_label:
Database Conversion
-------------------
@@ -276,13 +294,61 @@ This is example converts to SQLite MySQL/MariaDB::
For a more detailed explanation see
:doc:`../configuration_database/db_conversion`
.. _encryption_label:
Encryption
----------
When you are using encryption, you must manually migrate your encryption
keys after upgrading your ownCloud server::
ownCloud 8.2 introduces a new set of encryption commands::
$ sudo -u www-data php occ encryption:migrate
encryption:change-key-storage-root
encryption:show-key-storage-root
encryption:set-default-module
encryption:list-modules
encryption:encrypt-all
encryption:decrypt-all
encryption:disable
encryption:status
encryption:enable
encryption:enable-master-key
encryption:migrate
``encryption:status`` shows whether you have active encryption, and your default encryption module. To enable encryption you must first enable the Encryption app, and then run ``encryption:enable``::
$ sudo -u www-data php occ app:enable encryption
$ sudo -u www-data php occ encryption:enable
$ sudo -u www-data php occ encryption:status
- enabled: true
- defaultModule: OC_DEFAULT_MODULE
``encryption:change-key-storage-root`` is for moving your encryption keys to a different folder. It takes one argument, ``newRoot``, which defines your new root folder::
$ sudo -u www-data php occ encryption:change-key-storage-root /etc/oc-keys
You can see the current location of your keys folder::
sudo -u www-data php occ encryption:show-key-storage-root
Current key storage root: default storage location (data/)
``encryption:list-modules`` displays your available encryption modules. You will see a list of modules only if you have enabled the Encryption app. Use ``encryption:set-default-module [module name]`` to set your desired module.
``encryption:encrypt-all`` encrypts all data files for all users. You must first put your ownCloud server into single-user mode to prevent any user activity until encryption is completed.
``encryption:decrypt-all`` decrypts all user data files, or optionally a single user::
$ sudo -u www-data php occ encryption:decrypt freda
Users must have enabled recovery keys on their Personal pages. You must first put your ownCloud server into single-user mode to prevent any user activity until encryption is completed.
Use ``encryption:disable`` to disable your encryption module. You must first put your ownCloud server into single-user mode to prevent any user activity.
``encryption:enable-master-key`` creates a new master key, which is used for all user data instead of individual user keys. This is especially useful to enable single-sign on. Use this only on fresh installations with no existing data, or on systems where encryption has not already been enabled. It is not possible to disable it.
``encryption:migrate`` migatres encryption keys after a major ownCloud version upgrade. You may optionally specify individual users in a space-delimited list.
See :doc:`../configuration_files/encryption_configuration` to learn more.
.. _file_operations_label:
File Operations
---------------
@@ -307,98 +373,9 @@ search path::
``files:cleanup`` tidies up the server's file cache by deleting all file
entries that have no matching entries in the storage table.
.. _cli_installation:
Command Line Installation
-------------------------
You can install ownCloud entirely from the command line. After downloading the
tarball and copying ownCloud into the appropriate directories, or
after installing ownCloud packages (See
:doc:`../installation/linux_installation` and
:doc:`../installation/source_installation`) you can use ``occ`` commands in
place of running the graphical Installation Wizard.
Apply correct permissions to your ownCloud directories; see
:ref:`strong_perms`. Then choose your ``occ`` options. This lists your
available options::
$ sudo -u www-data php /var/www/owncloud/occ
ownCloud is not installed - only a limited number of commands are available
ownCloud version 8.1.0
Usage:
[options] command [arguments]
Options:
--help (-h) Display this help message
--quiet (-q) Do not output any message
--verbose (-v|vv|vvv) Increase the verbosity of messages: 1 for normal
output, 2 for more verbose output and 3 for debug
--version (-V) Display this application version
--ansi Force ANSI output
--no-ansi Disable ANSI output
--no-interaction (-n) Do not ask any interactive question
Available commands:
check check dependencies of the server environment
help Displays help for a command
list Lists commands
status show some status information
app
app:check-code check code to be compliant
l10n
l10n:createjs Create javascript translation files for a given app
maintenance
maintenance:install install ownCloud
Display your ``maintenance:install`` options::
$ sudo -u www-data php occ help maintenance:install
ownCloud is not installed - only a limited number of commands are available
Usage:
maintenance:install [--database="..."] [--database-name="..."]
[--database-host="..."] [--database-user="..."] [--database-pass[="..."]]
[--database-table-prefix[="..."]] [--admin-user="..."] [--admin-pass="..."]
[--data-dir="..."]
Options:
--database Supported database type (default: "sqlite")
--database-name Name of the database
--database-host Hostname of the database (default: "localhost")
--database-user User name to connect to the database
--database-pass Password of the database user
--database-table-prefix Prefix for all tables (default: oc_)
--admin-user User name of the admin account (default: "admin")
--admin-pass Password of the admin account
--data-dir Path to data directory (default:
"/var/www/owncloud/data")
--help (-h) Display this help message
--quiet (-q) Do not output any message
--verbose (-v|vv|vvv) Increase the verbosity of messages: 1 for normal
output, 2 for more verbose output and 3 for debug
--version (-V) Display this application version
--ansi Force ANSI output
--no-ansi Disable ANSI output
--no-interaction (-n) Do not ask any interactive question
This example completes the installation::
$ cd /var/www/owncloud/
$ sudo -u www-data php occ maintenance:install --database
"mysql" --database-name "owncloud" --database-user "root" --database-pass
"password" --admin-user "admin" --admin-pass "password"
ownCloud is not installed - only a limited number of commands are available
ownCloud was successfully installed
Supported databases are::
- sqlite (SQLite3 - Community Edition Only)
- mysql (MySQL/MariaDB)
- pgsql (PostgreSQL)
- oci (Oracle)
.. _create_javascript_translation_files_label:
l10n, Create javascript Translation Files for Apps
l10n, Create Javascript Translation Files for Apps
--------------------------------------------------
Use the ``l10n:createjs`` to migrate your PHP-based translation files into Javascript files::
@@ -439,10 +416,12 @@ Names of Languages
en_GB fy_NL mg sl
en_NZ gl mk sq
.. _ldap_commands_label:
LDAP Commands
-------------
You can run the following LDAP commands with ``occ``.
These LDAP commands appear only when you have enabled the LDAP backend on your Apps page. Then you can run the following LDAP commands with ``occ``.
Search for an LDAP user, using this syntax::
@@ -505,13 +484,38 @@ the server::
The configuration is valid and the connection could be established!
``ldap:show-remnants`` is for cleaning up the LDAP mappings table, and is
documented in :doc:`../configuration_user/user_auth_ldap_cleanup`.
documented in :doc:`../configuration_user/user_auth_ldap_cleanup`.
.. _logging_commands_label:
Logging Commands
----------------
Run ``log:owncloud`` to see your current logging status::
$ sudo -u www-data php occ log:owncloud
Log backend ownCloud: enabled
Log file: /opt/owncloud/data/owncloud.log
Rotate at: disabled
Use the ``--enable`` option to turn on logging. Use ``--file`` to set a different log file path. Set your rotation by log file size in bytes with ``--rotate-size``; 0 disables rotation.
``log:manage`` sets your logging backend, log level, and timezone. The defaults are ``owncloud``, ``Warning``, and ``UTC``. Available options are:
* --backend [owncloud, syslog, errorlog]
* --level [debug, info, warning, error]
.. _maintenance_commands_label:
Maintenance Commands
--------------------
These maintenance commands put your ownCloud server into
maintenance and single-user mode, and run repair steps during updates.
The available maintenance commands are:
* maintenance:mimetype:update-db
* maintenance:mode
* maintenance:repair
* maintenance:singleuser
You must put your ownCloud server into maintenance mode whenever you perform an
update or upgrade. This locks the sessions of all logged-in users, including
@@ -530,7 +534,7 @@ troubleshooting on a running server::
$ sudo -u www-data php occ maintenance:singleuser --on
Single user mode enabled
And turn it off when you're finished::
Turn it off when you're finished::
$ sudo -u www-data php occ maintenance:singleuser --off
Single user mode disabled
@@ -551,7 +555,11 @@ to::
- 0 tags for delete files have been removed.
- 0 tag entries for deleted tags have been removed.
- 0 tags with no entries have been removed.
- Re-enable file app
- Re-enable file app
``maintenance:mimetype:update-db`` updates the ownCloud database and file cache with changed mimetypes found in ``config/mimetypemapping.json``. Run this command after modifying ``config/mimetypemapping.json``. If you change a mimetype, run ``maintenance:mimetype:update-db --repair-filecache`` to apply the change to existing files.
.. _user_commands_label:
User Commands
-------------
@@ -638,9 +646,106 @@ authentication servers such as LDAP::
| | |
| user directories | 2 |
+------------------+----+
.. _command_line_installation_label:
Command Line Installation
-------------------------
These commands are available only after you have downloaded and unpacked the ownCloud archive, and before you complete the installation.
You can install ownCloud entirely from the command line. After downloading the
tarball and copying ownCloud into the appropriate directories, or
after installing ownCloud packages (See
:doc:`../installation/linux_installation` and
:doc:`../installation/source_installation`) you can use ``occ`` commands in
place of running the graphical Installation Wizard.
Apply correct permissions to your ownCloud directories; see
:ref:`strong_perms_label`. Then choose your ``occ`` options. This lists your
available options::
$ sudo -u www-data php /var/www/owncloud/occ
ownCloud is not installed - only a limited number of commands are available
ownCloud version 8.2.0
Usage:
[options] command [arguments]
Options:
--help (-h) Display this help message
--quiet (-q) Do not output any message
--verbose (-v|vv|vvv) Increase the verbosity of messages: 1 for normal
output, 2 for more verbose output and 3 for debug
--version (-V) Display this application version
--ansi Force ANSI output
--no-ansi Disable ANSI output
--no-interaction (-n) Do not ask any interactive question
Available commands:
check check dependencies of the server environment
help Displays help for a command
list Lists commands
status show some status information
app
app:check-code check code to be compliant
l10n
l10n:createjs Create javascript translation files for a given app
maintenance
maintenance:install install ownCloud
Display your ``maintenance:install`` options::
$ sudo -u www-data php occ help maintenance:install
ownCloud is not installed - only a limited number of commands are available
Usage:
maintenance:install [--database="..."] [--database-name="..."]
[--database-host="..."] [--database-user="..."] [--database-pass[="..."]]
[--database-table-prefix[="..."]] [--admin-user="..."] [--admin-pass="..."]
[--data-dir="..."]
Options:
--database Supported database type (default: "sqlite")
--database-name Name of the database
--database-host Hostname of the database (default: "localhost")
--database-user User name to connect to the database
--database-pass Password of the database user
--database-table-prefix Prefix for all tables (default: oc_)
--admin-user User name of the admin account (default: "admin")
--admin-pass Password of the admin account
--data-dir Path to data directory (default:
"/var/www/owncloud/data")
--help (-h) Display this help message
--quiet (-q) Do not output any message
--verbose (-v|vv|vvv) Increase the verbosity of messages: 1 for normal
output, 2 for more verbose output and 3 for debug
--version (-V) Display this application version
--ansi Force ANSI output
--no-ansi Disable ANSI output
--no-interaction (-n) Do not ask any interactive question
This example completes the installation::
$ cd /var/www/owncloud/
$ sudo -u www-data php occ maintenance:install --database
"mysql" --database-name "owncloud" --database-user "root" --database-pass
"password" --admin-user "admin" --admin-pass "password"
ownCloud is not installed - only a limited number of commands are available
ownCloud was successfully installed
Supported databases are::
- sqlite (SQLite3 - Community Edition Only)
- mysql (MySQL/MariaDB)
- pgsql (PostgreSQL)
- oci (Oracle)
.. _command_line_upgrade_label:
Upgrade Command
---------------
Command Line Upgrade
--------------------
These commands are available only after you have downloaded upgraded packages or archives, and before you complete the upgrade.
List all options, like this example on CentOS Linux::
@@ -711,21 +816,6 @@ or to use in a bug report::
ServerNotAvailableException: LDAP server is not available
Update failed
Turned off maintenance mode
.. uncomment when 8.1.1 is released
.. If you enable verbosity you'll see even more details
.. of the upgrade process::
.. ownCloud or one of the apps require upgrade - only a limited number of
.. commands are available
.. Turned on maintenance mode
.. Repair step: Repair MySQL database engine
.. Repair info: Not a mysql database -> nothing to do
.. Repair step: Repair MySQL collation
.. Repair info: Not a mysql database -> nothing to no
.. Repair step: Repair SQLite autoincrement
.. ...
.. Update successful
.. Turned off maintenance mode
Before completing the upgrade, ownCloud first runs a simulation by
copying all database tables to a temporary directory and then performing the

78
admin_manual/configuration_server/performance_tuning/webserver_tips.rst
View File

@@ -107,23 +107,24 @@ down errors.
.. todo: loglevel?
MaxKeepAliveRequests 4096
^^^^^^^^^^^^^^^^^^^^^^^^^
.. commented out until somebody knows what to do with it
.. MaxKeepAliveRequests 4096
.. ^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: apache
.. .. code-block:: apache
<IfModule prefork.c>
StartServers 100
MinSpareServers 100
MaxSpareServers 2000
ServerLimit 6000
MaxClients 6000
MaxRequestsPerChild 4000
</IfModule>
.. <IfModule prefork.c>
.. StartServers 100
.. MinSpareServers 100
.. MaxSpareServers 2000
.. ServerLimit 6000
.. MaxClients 6000
.. MaxRequestsPerChild 4000
.. </IfModule>
<Directory "/var/www/html">
Options Indexes SymLinksIfOwnerMatch AllowOverride All
</Directory>
.. <Directory "/var/www/html">
.. Options Indexes SymLinksIfOwnerMatch AllowOverride All
.. </Directory>
Nginx: caching ownCloud gallery thumbnails
------------------------------------------
@@ -272,7 +273,7 @@ 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:
your path created:
.. code-block:: bash
@@ -283,25 +284,36 @@ Configure Nginx with the ``nginx-cache-purge`` module
.. code-block:: bash
sudo vi /etc/nginx/sites-enabled/{your-ownCloud-nginx-config-file}
Add at the *beginning*, but *outside* the ``server{}`` block::
# cache_purge
fastcgi_cache_path {path} levels=1:2 keys_zone=OWNCLOUD:100m inactive=60m;
map $request_uri $skip_cache {
default 1;
~*/thumbnail.php 0;
~*/apps/galleryplus/ 0;
~*/apps/gallery/ 0;
}
.. note:: Please adopt or delete any regex line in the ``map`` block according
your needs and the ownCloud version used.
.. note:: As an alternative to mapping, you can use as many ``if`` statements in
your server block as necessary::
set $skip_cache 1;
if ($request_uri ~* "thumbnail.php") { set $skip_cache 0; }
if ($request_uri ~* "/apps/galleryplus/") { set $skip_cache 0; }
if ($request_uri ~* "/apps/gallery/") { set $skip_cache 0; }
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";
# cache_purge (with $http_cookies we have unique keys for the user)
fastcgi_cache_key $http_cookie$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)(/.+)$;
@@ -311,28 +323,30 @@ Add *inside* the ``server{}`` block, as an example of a configuration::
fastcgi_param HTTPS on;
fastcgi_pass php-handler;
# cache_purge
fastcgi_cache_bypass $skip_cache;
fastcgi_no_cache $skip_cache;
fastcgi_cache OWNCLOUD;
fastcgi_cache_valid 60m;
fastcgi_cache_methods GET HEAD;
}
.. note: Note regarding the ``fastcgi_pass`` parameter:
.. note:: Note regarding the ``fastcgi_pass`` parameter:
Use whatever fits your configuration. In the example above, an ``upstream``
was defined in an Nginx global configuration file.
This then can look like::
This may look like::
upstream php-handler {
server 127.0.0.1:9000;
server unix:/var/run/php5-fpm.sock;
# or
#server unix:/var/run/php5-fpm.sock;
# server 127.0.0.1:9000;
}
3. **Test the configuration**
.. code-block:: bash
sudo service nginx restart
sudo nginx -s reload
* Open your browser and clear your cache.
* Logon to your ownCloud instance, open the gallery app, move thru your
@@ -343,4 +357,4 @@ Add *inside* the ``server{}`` block, as an example of a configuration::
* 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.
the high load before.

12
admin_manual/configuration_server/security_setup_warnings.rst
View File

@@ -31,6 +31,18 @@ you need to upgrade, or, if you're not using it, remove it.
You are not required to use any caches, but caches improve server performance.
See :doc:`caching_configuration`.
Transactional file locking
--------------------------
"Transactional file locking is disabled, this might lead to issues with race
conditions."
"Transactional file locking is using the database as locking backend, for best
performance it's advised to configure a memcache for locking."
Please see :doc:`../configuration_files/files_locking_transactional` on how
to correctly configure your environment for transactional file locking.
You are accessing this site via HTTP
------------------------------------

12
admin_manual/contents.rst
View File

@@ -23,12 +23,12 @@ Enterprise Subscription Only
.. toctree::
:maxdepth: 3
enterprise_installation/index
enterprise_clients/index
enterprise_firewall/index
enterprise_user_management/index
enterprise_external_storage/index
enterprise_files_drop/index
enterprise_server_branding/index
enterprise_external_storage/index
enterprise_user_management/index
enterprise_files_drop/index
enterprise_logging/index
enterprise_firewall/index

14
admin_manual/enterprise_clients/publishing_android_app.rst
View File

@@ -47,14 +47,18 @@ Mint, and Ubuntu Linux you need to install two packages. The first one supplies
$ sudo apt-get install openjdk-7-jre-headless
$ sudo apt-get install openjdk-7-jdk
Plus some additional 32-bit packages::
$ sudo apt-get install libc6-i386 lib32stdc++6 lib32gcc1 lib32ncurses5
zlib1g:i386
On SUSE systems, install this package::
$ sudo zypper install java-1_7_0-openjdk-devel
It is simpler to get these on CentOS and Red Hat Enterprise Linux, as they have
created some nice
wrapper scripts around ``keytool`` and ``jarsigner`` that you can install
standalone::
created some nice wrapper scripts around ``keytool`` and ``jarsigner`` that you
can install standalone::
$ sudo yum install keytool-maven-plugin.noarch
$ sudo yum install maven-jarsigner-plugin.noarch
@@ -105,7 +109,7 @@ must both have a password, which can be same for both. Then enter your company
information as you are prompted::
$ keytool -genkey -v -keystore acme-release-key.keystore -alias acme_key
-keyalg RSA -keysize 2048
-keyalg RSA -keysize 2048 -validity 10000
Enter keystore password:
Re-enter new password:
What is your first and last name?
@@ -231,7 +235,7 @@ to your ownCloud server and share it like any other file: you can create normal
ownCloud shares with ownCloud users and groups, and you may create a link share
to share it with anyone. (See the **Files & Synchronization** section of the
`ownCloud User Manual
<https://doc.owncloud.org/server/8.2/user_manual/files/index.html>`_ to learn
<https://doc.owncloud.org/server/9.0/user_manual/files/index.html>`_ to learn
more about sharing files.)
.. _publish_google_play:

22
admin_manual/enterprise_external_storage/windows-network-drive_configuration.rst
View File

@@ -99,12 +99,20 @@ the server address, the share name, and the folder you want to connect to.
You have four options for login credentials:
* **User credentials**.
* **Global credentials**, which uses the credentials set in the Global
* **User credentials**. For admin-created global mountpoints; users must
click on the share and then enter their personal credentials to access the
share.
* **Global credentials**. Uses the credentials set in the Global
credentials fields
* **Login credentials** is for users to connect to the mountpoint using their
DOMAIN/logincredentials; enter the domain in the **Domain** field.
* **Custom Credentials**
DOMAIN/login credentials; enter the domain in the **Domain** field.
* **Custom Credentials**. On admin-created global mountpoints, the admin may
configure custom credentials to access the shares. For example, the admin
uses a single system account to mount company folders for all users. The
folder permissions are mapped with the system account permissions. When users
create a share on their Personal pages, custom credentials are only for that
mountpoint. For example, User A creates a mountpoint that is accessible with
User B's credentials.
.. figure:: images/wnd-2.png
:scale: 45%
@@ -112,7 +120,11 @@ You have four options for login credentials:
*Figure 2: Windows Network Drive configuration panel. (Click to enlarge.)*
When you're finished click the **Save** button.
When you're finished click the **Save** button.
.. note:: When you create a new mountpoint using Login credentials you must log out of ownCloud, and then log back in so you can access the share. You only have to do this the first time.
Personal SMB Mounts
-------------------

29
admin_manual/enterprise_installation/linux_installation.rst
View File

@@ -1,18 +1,22 @@
====================================================
Installing ownCloud Enterprise Subscription on Linux
====================================================
=======================================================
Installing & Upgrading ownCloud Enterprise Subscription
=======================================================
The recommended method for installing and maintaining your ownCloud Enterprise
Subscription is with your Linux package manager. Configure your package manager to
use the ownCloud Enterprise Subscription repository, import the signing key, and then
install and update ownCloud like any other software package. Please refer to
the ``README - ownCloud Package Installation.txt`` document in your account at
`Customer.owncloud.com <https://customer.owncloud.com/owncloud/>`_ account for
instructions on setting up your Linux package manager.
Subscription is with your Linux package manager. Configure your package manager
to use the ownCloud Enterprise Subscription repository, import the signing key,
and then install and update ownCloud packages like any other software package.
Please refer to the ``README - ownCloud Package Installation.txt`` document in
your account at `Customer.owncloud.com
<https://customer.owncloud.com/owncloud/>`_ account for instructions on setting
up your Linux package manager.
After you have completed your initial installation of ownCloud as detailed in
the README, follow the instructions in :doc:`../installation/installation_wizard` to finish
setting up ownCloud.
the README, follow the instructions in
:doc:`../installation/installation_wizard` to finish setting up ownCloud.
To upgrade your Enterprise Subscription, refer to
:doc:`../maintenance/upgrade`.
SELinux
-------
@@ -20,6 +24,3 @@ SELinux
Linux distributions that use SELinux need to take some extra steps so that
ownCloud will operate correctly under SELinux. Please see
:doc:`../installation/selinux_configuration` for some recommended configurations.

9
admin_manual/enterprise_ios_app/publishing_ios_app_5.rst
View File

@@ -3,12 +3,13 @@ Create Provisioning Profiles
============================
The next phase of this glorious journey is to create eight provisioning
profiles: 4 Ad Hoc and 4 App Store. You will email the four Ad Hoc profiles,
profiles: 4 Ad Hoc and :ref:`4 App Store <app_store_profiles_label>`. You will
email the four Ad Hoc profiles,
and your :doc:`P12 certificate <publishing_ios_app_6>` (which you will create
after your provisioning profiles), to branding@owncloud.com after building your
branded app with the ownBrander app on `Customer.owncloud.com
<https://customer.owncloud.com/owncloud>`_. Do not send us the App Store
profiles. All eight of these profiles must be stored on your Mac PC.
<https://customer.owncloud.com/owncloud>`_. **Do not send us the App Store
profiles.** All eight of these profiles must be stored on your Mac PC.
First Ad Hoc Provisioning Profile
---------------------------------
@@ -152,6 +153,8 @@ Provisioning Profiles".
.. figure:: ../images/cert-59.png
.. _app_store_profiles_label:
Create Four App Store Profiles
------------------------------

10
admin_manual/enterprise_ios_app/publishing_ios_app_9.rst
View File

@@ -4,11 +4,11 @@ Publishing Your New Branded iOS App
At last, after following all the previous steps and passing beta testing, your
branded iOS app is ready to publish for general distribution on iTunes. You need
a Mac computer with Xcode installed (Xcode is a free download), and you need
the three provisioning profiles and p12 file that you created copied to the
same computer that you are using to upload your app to iTunes. You will also
need a number of screenshots of your app in specific sizes and resolutions,
which are detailed in your iTunes Connect setup screen.
a Mac computer with Xcode installed (Xcode is a free download), and you need the
eight provisioning profiles (4 Ad Hoc and 4 Apple Store) and p12 file that you
created copied to the same computer that you are using to upload your app to
iTunes. You will also need a number of screenshots of your app in specific sizes
and resolutions, which are detailed in your iTunes Connect setup screen.
.. Note:: Apple must review and approve your app, and the approval process can
take several days to several weeks.

37
admin_manual/enterprise_logging/enterprise_logging_apps.rst Normal file
View File

@@ -0,0 +1,37 @@
=======================
Enterprise Logging Apps
=======================
There are two enterprise logging apps available to ownCloud Enterprise
Subscription customers: **Log file sharing** and **Log user actions**. The **Log
file sharing** app records the file sharing activity of your users, and **Log
user actions** records user logins and logouts.
.. figure:: images/logging-1.png
:alt: The two enterprise logging apps on the Apps page.
These two apps work together, and should be enabled together. Your logging
level must be set to at least **Info, warnings, errors, and fatal issues** on
your ownCloud admin page, or ``'loglevel' => 1`` in ``config.php``.
View your logfiles on your admin page. This shows which logging app recorded
the entries, timestamps, usernames, and their activities:
.. figure:: images/logging-3.png
:alt: Graphical log example.
Click the **Download logfile** button to dump the plain text log, or open the
logfile directly in a text editor. The default location is
``owncloud/data/owncloud.log``. This is what the raw log looks like::
{"reqId":"uaG6sHiutvgzVUCUXM3W","remoteAddr":"::1","app":"admin_audit",
"message":"Rename \"\/molly\/files\/server-and-enterprise-installation\" to
\"\/molly\/files\/shared\/server-and-enterprise-installation\" by user molly,
owner: molly","level":1,"time":"2015-10-21T22:07:14+00:00"}
{"reqId":"Krsnp8BgtLCtuT4zLTWs","remoteAddr":"::1","app":"admin_audit",
"message":"Rename \"\/molly\/files\/shared\/San%20Francisco.jpg\" to
\"\/molly\/files\/shared\/SanFrancisco.jpg\" by user molly, owner:
molly","level":1,"time":"2015-10-21T22:07:25+00:00"}
See :doc:`../configuration_server/logging_configuration` for more information
on logging.

BIN
admin_manual/enterprise_logging/images/logging-1.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 22 KiB

BIN
admin_manual/enterprise_logging/images/logging-3.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 22 KiB

8
admin_manual/enterprise_logging/index.rst Normal file
View File

@@ -0,0 +1,8 @@
=================================
Enterprise Logging Apps (ES only)
=================================
.. toctree::
:maxdepth: 2
enterprise_logging_apps

7
admin_manual/enterprise_server_branding/enterprise_server_branding.rst
View File

@@ -32,6 +32,11 @@ them.
:alt: ownBrander wizard with instructions, upload buttons for your custom
branded images, and example screenshots
.. note:: If you see errors when you upload SVG files, such as "Incorrect
extension.File type image/svg+xml is not correct", "This SVG is invalid",
or "Error uploading file: Incorrect size", try opening the file in
`Inkscape <https://inkscape.org/en/>`_ and then upload your SVG image again.
The wizard has two sections. The first section contains all the required
elements: logos and other artwork, colors, naming, and your enterprise URL. The
Suggested section contains optional items such as additional logo placements
@@ -56,4 +61,4 @@ the same file structure as the default theme, and you may further customize it
by editing the source files.
.. Note:: Always edit only your custom theme files. Never edit the default
theme files.
theme files.

BIN
admin_manual/images/encryption1.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 9.2 KiB

BIN
admin_manual/images/encryption14.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 12 KiB

BIN
admin_manual/images/encryption3.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 38 KiB

BIN
admin_manual/images/upgrade-1.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 32 KiB

2
admin_manual/installation/apps_management_installation.rst
View File

@@ -94,7 +94,7 @@ API. If they are then they will not be installed.
.. note:: If you would like to create or add your own ownCloud app, please use the
*Add your App...* button on the same page. This button redirects you to the
`App Development documentation
<https://doc.owncloud.org/server/8.2/developer_manual/app/index.html>`_,
<https://doc.owncloud.org/server/9.0/developer_manual/app/index.html>`_,
where you can find information about creating and adding your own apps.
Using Custom App Directories

6
admin_manual/installation/command_line_installation.rst
View File

@@ -12,12 +12,12 @@ and unpack the tarball in the appropriate directories. (See
:doc:`linux_installation` and :doc:`source_installation`.)
2. Apply the correction permissions to your ownCloud files and directories (see
:ref:`strong_perms`.)
:ref:`strong_perms_label`.)
3. Use the ``occ`` command to complete your installation. This takes the place
of running the graphical Installation Wizard.
You must run ``occ`` as your HTTP user; see :ref:`http_user`. This example
You must run ``occ`` as your HTTP user; see :ref:`http_user_label`. This example
shows how to complete your ownCloud installation with ``occ`` on Ubuntu Linux::
$ cd /var/www/owncloud/
@@ -38,4 +38,4 @@ Supported databases are::
- pgsql (PostgreSQL)
- oci (Oracle)
See :ref:`cli_installation` for more information.
See :ref:`command_line_installation_label` for more information.

BIN
admin_manual/installation/images/upgrade-1.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 26 KiB

BIN
admin_manual/installation/images/upgrade-2.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 46 KiB

42
admin_manual/installation/installation_wizard.rst
View File

@@ -20,20 +20,18 @@ This is just three steps:
You're finished and can start using your new ownCloud server.
Of course, there is much more that you can do to set up your ownCloud server
for
best performance and security. In the following sections we will cover
important
Of course, there is much more that you can do to set up your ownCloud server for
best performance and security. In the following sections we will cover important
installation and post-installation steps. Note that you must follow the
instructions in :ref:`Setting Strong Permissions <label-setting-strong-perms>`
in order to use the :doc:`occ Command <../configuration_server/occ_command>`.
instructions in :ref:`Setting Strong Permissions <strong_perms_label>` in order
to use the :doc:`occ Command <../configuration_server/occ_command>`.
* :ref:`Data Directory Location <label-data-directory-location>`
* :ref:`Database Choice <label-database-choice>`
* :ref:`Trusted Domains <label-trusted-domains>`
* :ref:`Setting Strong Permissions <label-setting-strong-perms>`
* :ref:`Data Directory Location <data_directory_location_label>`
* :ref:`Database Choice <database_choice_label>`
* :ref:`Trusted Domains <trusted_domains_label>`
* :ref:`Setting Strong Permissions <strong_perms_label>`
.. _label-data-directory-location:
.. _data_directory_location_label:
Data Directory Location
-----------------------
@@ -51,9 +49,10 @@ ownCloud data in a different location for other reasons (e.g. on a storage
server). It is best to configure your data directory location at installation,
as it is difficult to move after installation. You may put it anywhere; in this
example is it located in ``/var/oc_data``. This directory must already exist,
and must be owned by your HTTP user (see :ref:`label-setting-strong-perms`).
and must be owned by your HTTP user (see
:ref:`strong_perms_label`).
.. _label-database-choice:
.. _database_choice_label:
Database Choice
---------------
@@ -62,7 +61,7 @@ SQLite is the default database for ownCloud Server (it is not
available and not supported in the Enterprise edition), and it is good only for
testing and lightweight single-user setups without client synchronization.
Supported databases are MySQL, MariaDB, Oracle 11g, and PostgreSQL, and we
recommend :doc:`MySQL/MariaDB <../release_notes>`. Your database and PHP
recommend :doc:`MySQL/MariaDB <system_requirements>`. Your database and PHP
connectors must be installed before you run the Installation Wizard. When you
install ownCloud from packages all the necessary dependencies will be satisfied
(see :doc:`source_installation` for a detailed listing of required and optional
@@ -79,7 +78,7 @@ Click Finish Setup, and start using your new ownCloud server.
Now we will look at some important post-installation steps.
.. _label-trusted-domains:
.. _trusted_domains_label:
Trusted Domains
---------------
@@ -108,10 +107,8 @@ is not whitelisted the following error appears:
:alt: screenshot of error message when URL is not whitelisted in
trusted_domains
.. _label-setting-strong-perms:
.. _strong_perms:
.. _strong_perms_label:
Setting Strong Directory Permissions
------------------------------------
@@ -144,18 +141,19 @@ replace the ``htuser`` and ``htgroup`` variables with your HTTP user and group::
ocpath='/var/www/owncloud'
htuser='www-data'
htgroup='www-data'
rootuser='root' # On QNAP this is admin
find ${ocpath}/ -type f -print0 | xargs -0 chmod 0640
find ${ocpath}/ -type d -print0 | xargs -0 chmod 0750
chown -R root:${htuser} ${ocpath}/
chown -R ${rootuser}:${htgroup} ${ocpath}/
chown -R ${htuser}:${htgroup} ${ocpath}/apps/
chown -R ${htuser}:${htgroup} ${ocpath}/config/
chown -R ${htuser}:${htgroup} ${ocpath}/data/
chown -R ${htuser}:${htgroup} ${ocpath}/themes/
chown root:${htuser} ${ocpath}/.htaccess
chown root:${htuser} ${ocpath}/data/.htaccess
chown ${rootuser}:${htgroup} ${ocpath}/.htaccess
chown ${rootuser}:${htgroup} ${ocpath}/data/.htaccess
chmod 0644 ${ocpath}/.htaccess
chmod 0644 ${ocpath}/data/.htaccess

32
admin_manual/installation/linux_installation.rst
View File

@@ -8,21 +8,19 @@ Installation Quick Start
See the :doc:`system_requirements` for the recommended ownCloud setup and
supported platforms.
Installing ownCloud Server (the free community edition) on Linux from the
`openSUSE Build Service`_ packages is the preferred method. These are
maintained
by ownCloud engineers, and you can use your package manager to keep your
ownCloud server up-to-date. Follow the instructions for your distro to add the
oBS repository, download and install the repository signing key, and install
ownCloud. Then run the Installation Wizard to complete your installation. (see
:doc:`installation_wizard`).
Installing ownCloud Server (the free community edition) on Linux from our `Open
Build Service`_ packages is the preferred method. These are maintained by
ownCloud engineers, and you can use your package manager to keep your ownCloud
server up-to-date. Follow the instructions for your distro to add the ownCloud
Open Build Service repository, download and install the repository signing key,
and install ownCloud. Then run the Installation Wizard to complete your
installation. (see :doc:`installation_wizard`).
.. note:: Do not move the folders provided by these packages after the
installation, as this will break updates.
.. _openSUSE Build Service:
http://software.opensuse.org/download.html?project=isv:ownCloud:community&
package=owncloud
.. _Open Build Service:
https://download.owncloud.org/download/repositories/8.2/owncloud/
Installing ownCloud Enterprise Subscription
-------------------------------------------
@@ -36,8 +34,7 @@ Downgrading Not Supported
Downgrading is not supported and risks corrupting your data! If you want to
revert to an older ownCloud version, install it from scratch and then restore
your data from backup. Before doing this, file a support ticket (if you have
paid support) or ask for help in the ownCloud forums to see if your issue can
be
paid support) or ask for help in the ownCloud forums to see if your issue can be
resolved without downgrading.
Additional Installation Guides and Notes
@@ -69,4 +66,11 @@ Mageia software repository.
**Debian/Ubuntu:** The package installs an additional Apache config file to
``/etc/apache2/conf.d/owncloud.conf`` which contains an ``Alias`` to the
owncloud installation directory as well as some more needed configuration
options.
options.
**Running ownCloud in a subdir**: If you're running ownCloud in a subdir and
want to use CalDAV or CardDAV clients make sure you have configured the correct
:ref:`service-discovery-label` URLs.
**Note for MySQL/MariaDB environments**: Please refer to :ref:`db-binlog-label`
on how to correctly configure your environment if you have binary logging enabled.

4
admin_manual/installation/nginx_configuration.rst
View File

@@ -11,6 +11,10 @@ Nginx Configuration
**ssl_certificate_key** to suit your needs.
- Make sure your SSL certificates are readable by the server (see `Nginx HTTP
SSL Module documentation <http://wiki.nginx.org/HttpSslModule>`_).
- ``add_header`` statements are only taken from the current level and are not cascaded
from or to a different level. All necessary ``add_header`` statements must be defined
in each level needed. For better readability is is possible to move *common* add
header statements into a separate file and include that file wherever necessary.
.. note:: The following example assumes that your ownCloud is installed in
your webroot. If you're using a subfolder you need to adjust the configuration

20
admin_manual/installation/source_installation.rst
View File

@@ -2,7 +2,7 @@
Manual Installation on Linux
============================
Installing ownCloud on Linux from the openSUSE Build Service packages is the
Installing ownCloud on Linux from our Open Build Service packages is the
preferred method (see :doc:`linux_installation`). These are maintained by
ownCloud engineers, and you can use your package manager to keep your ownCloud
server up-to-date.
@@ -208,20 +208,23 @@ Additional Apache Configurations
the server configuration, as well as in the CommonName field of the
certificate. If you want your ownCloud to be reachable via the internet, then
set both of these to the domain you want to reach your ownCloud server.
* Now restart Apache::
service apache2 restart
.. note:: You can use ownCloud over plain HTTP, but we strongly encourage you to
use SSL/TLS to encrypt all of your server traffic, and to protect
user's logins and data in transit.
* If you're running ownCloud in a subdir and want to use CalDAV or CardDAV clients
make sure you have configured the correct :ref:`service-discovery-label` URLs.
.. _enabling-ssl-label:
Enabling SSL
------------
.. note:: You can use ownCloud over plain HTTP, but we strongly encourage you to
use SSL/TLS to encrypt all of your server traffic, and to protect
user's logins and data in transit.
Apache installed under Ubuntu comes already set-up with a simple
self-signed certificate. All you have to do is to enable the ssl module and
the default site. Open a terminal and run::
@@ -249,7 +252,8 @@ Setting Strong Directory Permissions
------------------------------------
We recommend setting the directory permissions in your ownCloud installation as
strictly as possible for stronger security. Please refer to :ref:`strong_perms`.
strictly as possible for stronger security. Please refer to
:ref:`strong_perms_label`.
SELinux
-------

17
admin_manual/issues/index.rst
View File

@@ -41,12 +41,20 @@ If you can't find a solution, please use our `bugtracker`_.
.. _webchat: http://webchat.freenode.net/?channels=owncloud
.. _Enterprise Subscription: https://owncloud.com/lp/community-or-enterprise/
.. _bugtracker:
http://doc.owncloud.org/server/8.2/developer_manual/bugtracker/index.html
http://doc.owncloud.org/server/9.0/developer_manual/bugtracker/index.html
.. TODO ON RELEASE: Update version number above on release
General Troubleshooting
-----------------------
Disable 3rdparty / non-shipped apps
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
It might be possible that 3rd party / non-shipped apps are causing various
different issues. Always disable 3rd party apps before upgrades, and for
troubleshooting. Please refer to the :ref:`apps_commands_label` on how
to disable an app from command line.
ownCloud Logfiles
^^^^^^^^^^^^^^^^^
@@ -239,6 +247,8 @@ which contains various additional information about WebDAV problems.
Troubleshooting Contacts & Calendar
-----------------------------------
.. _service-discovery-label:
Service discovery
^^^^^^^^^^^^^^^^^
@@ -248,11 +258,6 @@ when explicitly configured to use it.
There are several techniques to remedy this, which are described extensively at
the `Sabre DAV website <http://sabre.io/dav/service-discovery/>`_.
Apple iOS
^^^^^^^^^
Below is what has been proven to work with iOS including iOS 7.
If your ownCloud instance is installed in a subfolder under the web server's
document root and the client has difficulties finding the Cal- or CardDAV
end-points, configure your web server to redirect from a "well-known" URL to

BIN
admin_manual/maintenance/images/upgrade-1.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 26 KiB

BIN
admin_manual/maintenance/images/upgrade-2.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 46 KiB

12
admin_manual/maintenance/restore.rst
View File

@@ -5,10 +5,13 @@ Restoring ownCloud
To restore an ownCloud installation there are three main things you need to
restore:
#. The config folder
#. The data folder
#. The configuration directory
#. The data directory
#. The database
.. note:: You must have both the database and data directory. You cannot
complete restoration unless you have both of these.
When you have completed your restoration, see the ``Setting Strong Directory
Permissions`` section of :doc:`../installation/installation_wizard`.
@@ -16,9 +19,10 @@ Restore Folders
---------------
.. note:: This guide assumes that your previous backup is called
owncloud-dirbkp"
"owncloud-dirbkp"
Simply copy your config and data folder (or even your whole ownCloud install and
Simply copy your configuration and data folder (or even your whole ownCloud
install and
data folder) to your ownCloud environment. You could use this command::
rsync -Aax owncloud-dirbkp/ owncloud/

319
admin_manual/maintenance/upgrade.rst
View File

@@ -2,80 +2,84 @@
Upgrading Your ownCloud Server
==============================
Starting with ownCloud 8.2 the Linux package repositories have changed, and
**you must configure your system to use these new repos**. The new repos are at
our `Open Build Service`_. Just follow the instructions for your Linux
distribution, and then install new ownCloud packages in the usual way with your
package manager.
It is best to keep your ownCloud server upgraded regularly, and to install all
point releases and major releases without skipping any of them, as skipping
releases increases the risk of errors. Major releases are 6.0, 7.0, and 8.0, and
point releases are intermediate releases for each major release. For example,
8.0.1 and 8.0.2 are point releases.
releases increases the risk of errors. Major releases are 8.0, 8.1, 8.2, and
9.0. Point releases are intermediate releases for each major release. For
example, 8.0.9 and 8.1.3 are point releases.
.. note:: **Downgrading** is not supported and risks corrupting your data! If
you want to revert to an older ownCloud version, install it from scratch
and then restore your data from backup. Before doing this, file a support
ticket (if you have paid support) or ask for help in the ownCloud forums to
see if your issue can be resolved without downgrading.
Version numbering changed with ownCloud 8.0. Major releases are now indicated
by the second number, so 8.0. 8.1, and 8.2 are major releases. The third number
indicates an intermediate release, e.g. 8.0.5.
.. note:: If you are using the Encryption app and upgrading from older
versions of ownCloud to ownCloud 8.0, you must manually migrate your
encryption keys with the *occ* command after the upgrade is complete, like
this example for CentOS:
*sudo -u apache php occ encryption:migrate*
You must run *occ* as your HTTP user. See
:doc:`../configuration_server/occ_command` to learn more about *occ*
There are multiple ways to keep your ownCloud server upgraded: with the Updater
App (Server Edition only), with your Linux package manager, and by manually
upgrading. In this chapter you will learn how to keep your ownCloud installation
current with your Linux package manager, and by manually upgrading.
(See :doc:`update` to learn about the Updater App.)
.. note:: Before upgrading to a new major release, always first review any
third-party apps you have installed for compatibility with
the new ownCloud release. Any apps that are not developed by ownCloud show a
3rd party designation. Install unsupported apps at your own risk. Then,
before the upgrade, they must all be disabled. After the upgrade is
complete and you are sure they are compatible with the new ownCloud
release you may re-enable them.
Preferred Upgrade Method
------------------------
The best method for keeping ownCloud on Linux servers current is by
configuring your system to use the `openSUSE Build Service
<http://software.opensuse.org/download.html?project=isv:ownCloud:community&
package=owncloud>`_ (see :doc:`../installation/linux_installation`); just
follow the instructions on oBS for setting up your package manager. Then
stay current by using your Linux package manager to upgrade.
There are multiple ways to keep your ownCloud server upgraded: with the
:doc:`Updater App <update>` (Server Edition only), with your Linux package
manager, and by manually upgrading. In this chapter you will learn how to keep
your ownCloud installation current with your Linux package manager, and by
manually upgrading.
.. note:: Enterprise Subscription customers will use their Enterprise software
repositories to install and update their ownCloud installations, rather
than the openSUSE Build Service. Please see
repositories to install ownCloud packages, rather
than the Open Build Service. Then follow the instructions on this page
for completing upgrades. Please see
:doc:`../enterprise_installation/linux_installation` for more information.
You should always maintain regular backups (see :doc:`../maintenance/backup`),
and make a backup before every upgrade.
When you are upgrading to a major release, evaluate any third-party apps for
compatibility with the upgrade, and then disable them before upgrading. You may
re-enable them after the upgrade is completed.
When a new ownCloud release is available you will see a yellow banner in your
ownCloud Web interface.
.. note:: **Downgrading is not supported** and risks corrupting your data! If
you want to revert to an older ownCloud version, make a new, fresh
installation and then restore your data from backup. Before doing this,
file a support ticket (if you have paid support) or ask for help in the
ownCloud forums to see if your issue can be resolved without downgrading.
.. figure:: ../images/updater-1.png
Upgrade Quickstart
------------------
**Upgrading is disruptive**. When you upgrade ownCloud with your Linux package
manager, that is just the first step to applying the upgrade. After
downloading the new ownCloud packages your session will be interrupted, and you
must run the upgrade wizard to complete the upgrade, which is discussed in the
next section.
The best method for keeping ownCloud on Linux servers current is by configuring
your system to use ownCloud's `Open Build Service`_ repository. Then stay
current by using your Linux package manager to install fresh ownCloud packages.
After installing upgraded packages you must run a few more steps to complete
the upgrade. These are the basic steps to upgrading ownCloud:
* :doc:`Disable <../installation/apps_management_installation>` all third-party
apps.
* Make a :doc:`fresh backup <backup>`.
* Install new packages from the ownCloud `Open Build Service`_.
* Take your ownCloud server out of :doc:`maintenance mode
<enable_maintenance>`.
* Run the :ref:`upgrade wizard <upgrade_wizard_label>` (optionally disabling
the :ref:`migration test <migration_test_label>`).
* Log in and :ref:`apply strong permissions <strong_perms_label>` to your
ownCloud directories.
* Re-enable third-party apps.
Prerequisites
-------------
You should always maintain regular backups and make a fresh backup before every
upgrade.
Then review any third-party apps you have installed for compatibility with the
new ownCloud release. Any apps that are not developed by ownCloud show a 3rd
party designation. **Install unsupported apps at your own risk**. Then, before
the upgrade, they must all be disabled. After the upgrade is complete and you
are sure they are compatible with the new ownCloud release you may re-enable
them.
**Upgrading is disruptive**. Your ownCloud server will be automatically put
into maintenance mode, so your users will be locked out until the upgrade is
completed. Large installations may take several hours to complete the upgrade.
Upgrading With Your Linux Package Manager
-----------------------------------------
When an ownCloud upgrade is available from the openSUSE Build Service
repository, you can apply it just like any normal Linux upgrade. For example,
on Debian or Ubuntu Linux this is the standard system upgrade command::
When an ownCloud upgrade is available from ownCloud's `Open Build Service`_
repository, apply it just like any normal Linux upgrade. For example, on Debian
or Ubuntu Linux this is the standard system upgrade command::
$ sudo apt-get update && sudo apt-get upgrade
@@ -95,82 +99,85 @@ Or update only ownCloud::
$ sudo yum update owncloud
Your Linux package manager only downloads the current ownCloud packages. There
is one more step, and that is to run the upgrade wizard to perform the final
steps of updating the database and turning off maintenance mode. After using
your package manager to install the current ownCloud release, you will see two
screens. On the first screen, click the Start Upgrade button, or optionally run
the ``occ upgrade`` command instead of clicking the button.
Your Linux package manager only downloads the current ownCloud packages. Then
your ownCloud server is automatically put into maintenance mode.
.. figure:: ../images/updater-8.png
.. figure:: images/upgrade-1.png
:scale: 70%
:alt: ownCloud status screen informing users that it is in maintenance mode.
*Click to enlarge*
``occ upgrade``
is more reliable, especially on installations with large datasets and large
numbers of users because it avoids the risk of PHP timeouts.
Next, take your server out of maintenance mode. You can do this by changing
``'maintenance' => true,`` to ``'maintenance' => false,`` in ``config.php``, or
use the :doc:`occ command <../configuration_server/occ_command>`, like this
example on Ubuntu::
.. note:: The ``occ`` command does not download ownCloud updates. You must first download
the updated code, and then ``occ`` performs the final upgrade steps.
The ``occ`` command
is in your ``owncloud/`` directory. You must run it as your HTTP user. This
example is for Debian/Ubuntu::
$ sudo -u www-data php occ upgrade
$ sudo -u www-data php occ maintenance:mode --off
.. _upgrade_wizard_label:
Upgrade Wizard
--------------
The final step is to run the upgrade wizard to perform the final steps of
updating your apps and database. You will see a screen with a summary of apps
that are updated, and a **Start Update** button. If you have shell access it
is better to **not** click the Start Update button, but rather to use ``occ
upgrade``, like this example on CentOS::
$ sudo -u apache php occ upgrade
.. figure:: images/upgrade-2.png
:scale: 70%
:alt: ownCloud upgrade status screen
*Click to enlarge*
``occ upgrade`` is more reliable, especially on installations with large
datasets and large numbers of users because it avoids the risk of PHP timeouts.
When the upgrade is completed you will be returned to the login screen.
.. _migration_test_label:
Migration Test
^^^^^^^^^^^^^^
Before completing the upgrade, ownCloud first runs a simulation by copying all
database tables to a temporary directory and then performing the upgrade on
them, to ensure that the upgrade will complete correctly. This takes twice as
much time, which on large installations can be many hours, so you can omit this
step with the ``--skip-migration-test`` option::
them, to ensure that the upgrade will complete correctly. This can delay large
installations by several hours, so you can omit this step with the
``--skip-migration-test`` option, like this example on CentOS::
$ sudo -u www-data php occ upgrade --skip-migration-test
This example is for Fedora, CentOS, and Red Hat Linux::
$ sudo -u apache php occ upgrade --skip-migration-test
$ sudo -u apache php occ upgrade
Or::
Setting Strong Permissions
^^^^^^^^^^^^^^^^^^^^^^^^^^
$ sudo -u apache php occ upgrade -skip-migration-test
* The HTTP user and group in Debian/Ubuntu is ``www-data``.
* The HTTP user and group in Fedora/CentOS/RHEL is ``apache``.
* The HTTP user and group in Arch Linux is ``http``.
* The HTTP user in openSUSE is ``wwwrun``, and the HTTP group is ``www``.
See :doc:`../configuration_server/occ_command` to learn more about using the
``occ`` command, and see the **Setting Strong Directory Permissions** section
of :doc:`../installation/installation_wizard` to learn how to find your
HTTP user.
When the upgrade is successful you will see the following screen:
.. figure:: ../images/updater-7.png
After upgrading, verify that your ownCloud
directory permissions are set according to the **Setting Strong Directory Permissions**
section of :doc:`../installation/installation_wizard`.
After upgrading, verify that your ownCloud directory permissions are set
according to :ref:`strong_perms_label`.
If the upgrade fails, then you must try a manual upgrade.
Manual Upgrade Procedure
------------------------
If you are upgrading to a major release, for example from 7.0.5 to
8.0, you must review all third party applications (not core apps), for
Always start by making a fresh backup.
If you are upgrading to a major release, for example from 8.1.3 to
8.2, you must review all third party applications (not core apps) for
compatibility with your new ownCloud version. Then disable all of them
before starting the upgrade.
Next put your server in maintenance mode. This prevents new logins,
locks the sessions of logged-in users, and displays a status screen so users
know what is happening. There are two ways to do this, and the preferred method
is to use the ``occ`` command, which you must run as your HTTP user. This example
is for Ubuntu Linux::
Next put your server in maintenance mode. This prevents new logins, locks the
sessions of logged-in users, and displays a status screen so users know what is
happening. There are two ways to do this, and the preferred method is to use the
:doc:`occ command <../configuration_server/occ_command>`, which you must run as
your HTTP user. This example is for Ubuntu Linux::
$ sudo -u www-data php occ maintenance:mode --on
Please see :doc:`../configuration_server/occ_command` to learn more about ``occ``.
The other way is by entering your ``config.php`` file and changing
``'maintenance' => false,`` to ``'maintenance' => true,``.
@@ -182,25 +189,7 @@ The other way is by entering your ``config.php`` file and changing
of your current installation. For example, if your current ownCloud is
installed in ``/var/www/owncloud/`` you could create a new directory called
``/var/www/owncloud2/``
3. Stop your web server.
Apache 2 is the recommended server for ownCloud (see :doc:`../release_notes`
for recommended setups and supported platforms.)
+-----------------------+-----------------------------------------+
| Operating System | Command (as root) |
+=======================+=========================================+
| CentOS/ Red Hat | ``apachectl stop`` |
+-----------------------+-----------------------------------------+
| Debian | |
| or | ``/etc/init.d/apache2 stop`` |
| Ubuntu | |
+-----------------------+-----------------------------------------+
| SUSE Enterprise | |
| Linux 11 | ``/usr/sbin/rcapache2 stop`` |
| | |
| openSUSE 12.3 and up | ``systemctl stop apache2`` |
+-----------------------+-----------------------------------------+
3. Stop your Web server.
4. Rename or move your current ownCloud directory (named ``owncloud/`` if
installed using defaults) to another location.
@@ -226,22 +215,7 @@ for recommended setups and supported platforms.)
.. note:: We recommend storing your ``data/`` directory in a location other
than your ``owncloud/`` directory.
9. Restart your web server.
+-----------------------+-----------------------------------------+
| Operating System | Command (as root) |
+=======================+=========================================+
| CentOS/ Red Hat | ``apachectl start`` |
+-----------------------+-----------------------------------------+
| Debian | |
| or | ``/etc/init.d/apache2 start`` |
| Ubuntu | |
+-----------------------+-----------------------------------------+
| SUSE Enterprise | |
| Linux 11 | ``/usr/sbin/rcapache2 start`` |
| | |
| openSUSE 12.3 and up | ``systemctl start apache2`` |
+-----------------------+-----------------------------------------+
9. Restart your Web server.
10. Now you should be able to open a Web browser to your ownCloud server and
log in as usual. You have a couple more steps to go: You should see a
@@ -258,25 +232,18 @@ for recommended setups and supported platforms.)
.. note:: The ``occ`` command does not download ownCloud updates. You must first download
and install the updated code (steps 1-3), and then ``occ`` performs the final upgrade steps.
11. The upgrade operation takes a few minutes, depending on the size of your
installation. When it is finished you will see a success message, or an
error message that will tell where it went wrong.
11. The upgrade operation takes a few minutes to a few hours, depending on the
size of your installation. When it is finished you will see a success
message, or an error message that will tell where it went wrong.
Assuming your upgrade succeeded, take a look at the bottom of your Admin page to
verify the version number. Check your other settings to make sure they're
correct. Go to the Apps page and review the core apps to make sure the right
ones are enabled. Finally, re-enable your third-party apps.
ones are enabled. Re-enable your third-party apps. Then apply strong
permissions to your ownCloud directories (:ref:`strong_perms_label`).
Setting Strong Permissions
--------------------------
For hardened security we highly recommend setting the permissions on your
ownCloud directory as strictly as possible. After upgrading, verify that your ownCloud
directory permissions are set according to the **Setting Strong Directory Permissions**
section of :doc:`../installation/installation_wizard`.
Restore From Backup
-------------------
Reverse Upgrade
---------------
If you need to reverse your upgrade, see :doc:`restore`.
@@ -293,17 +260,7 @@ enabled, your upgrade may fail with these errors in your MySQL/MariaDB log::
to row-based logging. InnoDB is limited to row-logging when transaction
isolation level is READ COMMITTED or READ UNCOMMITTED.'
There are two solutions. One is to disable binary logging. Binary logging
records all changes to your database, and how long each change took. The
purpose of binary logging is to enable replication and to support backup
operations.
The other is to change the BINLOG_FORMAT = STATEMENT in your database
configuration file, or possibly in your database startup script, to
BINLOG_FORMAT = MIXED. See `Overview of the Binary
Log <https://mariadb.com/kb/en/mariadb/overview-of-the-binary-log/>`_ and `The
Binary Log <https://dev.mysql.com/doc/refman/5.6/en/binary-log.html>`_ for
detailed information.
Please refer to :ref:`db-binlog-label` on how to correctly configure your environment.
Occasionally, *files do not show up after a upgrade*. A rescan of the files can help::
@@ -312,16 +269,20 @@ Occasionally, *files do not show up after a upgrade*. A rescan of the files can
See `the owncloud.org support page <http://owncloud.org/support>`_ for further
resources for both home and enterprise users.
Sometimes, ownCloud can get *stuck in a upgrade*. This is usually due to the process taking too long and encountering a time-out. It is recommended to turn off the upgrade and start over with the manual process from the command line as described above under point 12.
Stop the upgrade process this way::
Sometimes, ownCloud can get *stuck in a upgrade*. This is usually due to the
process taking too long and encountering a PHP time-out. Stop the upgrade
process this way::
$ sudo -u www-data php occ maintenance:mode --off
And start the manual process::
Then start the manual process::
$ sudo -u www-data php occ upgrade
If this does not work properly, try the repair function::
$ sudo -u www-data php occ maintenance:repair
.. _Open Build Service:
https://download.owncloud.org/download/repositories/8.2/owncloud/

17
admin_manual/release_notes.rst
View File

@@ -2,9 +2,23 @@
ownCloud |version| Release Notes
================================
Changes in 9.0
--------------
Changes in 8.2
--------------
New location for Linux package repositories; ownCloud admins must manually
change to the new repos. See :doc:`maintenance/upgrade`
PHP 5.6.11+ breaks the LDAP wizard with a 'Could not connect to LDAP' error. See https://github.com/owncloud/core/issues/20020.
``filesystem_check_changes`` in ``config.php`` is set to 0 by default. This
prevents unnecessary update checks and improves performance. If you are using
external storage mounts such as NFS on a remote storage server, set this to 1
so that ownCloud will detect remote file changes.
XSendFile support has been removed, so there is no longer support for `serving
static files
<https://doc.owncloud.org/server/8.1/admin_manual/configuration_files/
@@ -23,6 +37,9 @@ Run ``sudo -u www-data php occ ldap:show-config`` to find the correct ``sNN``
value; if there is not one then use empty quotes, ``""``. (See
:doc:`configuration_server/occ_command`.)
Users of the Linux Package need to update their repository setup as described
in this `blogpost <https://owncloud.org/blog/upgrading-to-owncloud-server-8-2/>`_.
Changes in 8.1
--------------

126
admin_manual/whats_new_admin.rst
View File

@@ -2,106 +2,34 @@
What's New for Admins in ownCloud |version|
===========================================
New Packaging
-------------
See the `ownCloud 8.2
Features page <https://github.com/owncloud/core/wiki/ownCloud-8.2-Features>`_
on Github for a comprehensive list of new features and updates.
We are introducing a new packaging system (starting in ownCloud 8.0). Instead of
two editions, Community and Enterprise, we now offer Server to replace the old
Community edition, and Enterprise Subscription replaces the old Enterprise
Edition.
Some of the improvements of interest to ownCloud admins are:
Server includes core file share and synchronization features plus community
apps, and is community-supported and free of cost. See `owncloud.org
<https://owncloud.org/>`_ for current information and links to downloads.
* New ownCloud package repositories (admins must manually change to these, see
:doc:`maintenance/upgrade`)
* Configurable temporary directory
* Many new occ commands for logging, encryption, and apps
* Unavailable external storages are not rechecked every request; rather, their
failed state is saved and they are tried again after 10 minutes
* External storages now support modular authentication mechanisms
* Transactional file locking prevents data corruption and race conditions on
concurrent access
* Files app new sidebar shows details about files
* Admins can define custom mimetype mappings and aliases
* Mimetypes in the database can be updated when changed
* Downgrades are prevented because they are unsupported
* Admin page warning for EOL PHP version
* Show apps that will be updated on the DB update page
ownCloud now offers two levels of paid support:
There are many security enhancements, including:
* ownCloud Standard
* ownCloud Enterprise
The ownCloud Standard Subscription is for customers who want paid support for
the core Server, and do not need Enterprise apps. This includes:
* ownCloud Server
* ownCloud desktop and mobile apps (without the custom branding build service)
* ownCloud open-source apps licensed as AGPL (Share Files,
Federated Cloud, Versions, Deleted files, LDAP/AD, Antivirus, Encryption,
External Storage. etc.), 8x5 support hours
Note: This does not include support for Contacts, Calendar, Tasks, Chat,
Documents, or any other community-only apps, and it does not include support
for Enterprise-only apps or services.
The ownCloud Enterprise Subscription replaces the Enterprise Edition. This
includes the core Server plus Enterprise apps. The Enterprise Subscription
includes:
* ownCloud Standard Subscription
* ownCloud Enterprise apps (Logging modules, SAML, File Firewall, Sharepoint,
Windows Network Drive, Home Directory Mounts, etc)
* ownBrander for mobile app branding
* ownCloud Commercial License for closed-source customizations
* Up to 24x7 support
* Deployment assistance for the rollout
New customers, or customers upgrading from the old Enterprise Edition will
install ownCloud 8 from the existing ``owncloud-enterprise`` repository. The
``owncloud-server`` dependency will be pulled in automatically. Customers using
the community edition will upgrade via package manager by adding the
``owncloud-enterprise repository``, and installing ownCloud Enterprise Edition
apps on top of their ``owncloud-server``.
Visit `owncloud.com <https://owncloud.com/>`_ for more information on the
Enterprise Subscription.
Improvements and New Features
-----------------------------
ownCloud Server and Enterprise Subscription |version| are shipping with a batch
of improvements and new features, including:
* Auto-completion of usernames in file share dialogs
* Improved performance, with faster file transfers, much faster file deletion,
improved scalability through improved handling of parallel requests, and up
to 50% more users on each ownCloud server instance.
* Better file locking
* Updated encryption with support for multiple encryption backends and
migration tools for 8.0 -> 8.1
* Improved LDAP configuration wizard
* WebDAV performance enhancements
* SFTP external storage with SSH keys
* SMB external storage is now based on ``libsmbclient``
* Individual settings per external storage mount, including encryption and previews
* Improved performance and better storage space management of preview
generation
* UI improvements for configuring external storage
* The ownCloud Appstore shows now different trust levels, and allows enabling
experimental apps
* Deleted files & folders now keep the share info after restoring from trashbin
(local shares only and not external storage)
* Many more links from the administration UI to the relevant documentation
* ``occ`` command updated to allow installing ownCloud completely from the
command line
* User avatars are displayed in share dialogs
* Font preview, 3D pictures media type (previewed as JPEG) and raw media type
support without previews
* A new simple example theme is included
* All shares now have at least read permissions, which prevents unpredictable
server behavior
* Support for shortened URLs
* Users may not remove share expiration dates when the admin settings require
them
* Auto complete in share dialog works again when sharing is limited to groups
* `Developer changelog
<https://doc.owncloud.org/server/8.1/developer_manual/app/changelog.html>`_
is available in the Developer's Manual
* File IDs are now persistent when moving files across storages, deleted to
trashbin or restored as version
* Ship ca-bundle.crt to work around issues on systems that experience failed
connections to the Appstore
* Introduce new "OC-ETag" header fixing issues with server configs stripping off
ETags "No E-Tag received from server"
* $.get and $.post cannot be used to execute remote JavaScript
* Referers are not sent anymore to prevent leaking of potential sensitive
information within the URL such as the filename
* Autoloader will only allow loading files from enabled apps
* Encrypt session data to ensure that sensitive data such as remote storage
passwords or encryption keys are not written on disk
* If the shareAPI is disabled link shares no longer work

8
developer_manual/app/container.rst
View File

@@ -185,14 +185,14 @@ So basically the following is now possible:
}
}
$container = new \OCP\App('myapp');
$app = new \OCP\AppFramework\App('myapp');
$class2 = $container->query('OCA\MyApp\MyTestClass2');
$class2 = $app->getContainer()->query('OCA\MyApp\MyTestClass2');
$class2 instanceof MyTestClass2; // true
$class2->class instanceof MyTestClass; // true
$class2->appName === 'appname'; // true
$class2 === $container->query('OCA\MyApp\MyTestClass2'); // true
$class2 === $app->getContainer()->query('OCA\MyApp\MyTestClass2'); // true
.. note:: $AppName is resolved because the container registered a parameter under the key 'AppName' which will return the app id. The lookup is case sensitive so while $AppName will work correctly, using $appName as a constructor parameter will fail.
@@ -203,7 +203,7 @@ How does it affect the request lifecycle
* All apps' **routes.php** files are loaded
* If a **routes.php** file returns an array, and an **appname/appinfo/application.php** exists, include it, create a new instance of **\\OCA\\AppName\\AppInfo\\Application.php** and register the routes on it. That way a container can be used while still benefitting from the new routes behavior
* If a **routes.php** file returns an array, but there is no **appname/appinfo/application.php**, create a new \\OCP\\App instance with the app id and register the routes on it
* If a **routes.php** file returns an array, but there is no **appname/appinfo/application.php**, create a new \\OCP\\AppFramework\\App instance with the app id and register the routes on it
* A request is matched for the route, e.g. with the name **page#index**
* The appropriate container is being queried for the entry PageController (to keep backwards compability)

47
developer_manual/app/js.rst
View File

@@ -18,7 +18,18 @@ The JavaScript files reside in the **js/** folder and should be included in the
// add vendor files (also allows the array syntax)
vendor_script('myapp', 'script'); // adds vendor/script.js
The recommended JavaScript framework to use is `AngularJS <https://angularjs.org/#>`_. A nice tutorial screencast collection can be found on `Egghead.io <https://egghead.io/technologies/angularjs>`_
If the script file is only needed when the file list is displayed, you should
listen to the ``OCA\Files::loadAdditionalScripts`` event:
.. code-block:: php
<?php
$eventDispatcher = \OC::$server->getEventDispatcher();
$eventDispatcher->addListener('OCA\Files::loadAdditionalScripts', function() {
script('myapp', 'script'); // adds js/script.js
vendor_script('myapp', 'script'); // adds vendor/script.js
});
Sending the CSRF token
======================
@@ -46,3 +57,37 @@ Full URLs can be generated by using:
.. code-block:: js
var authorUrl = OC.generateUrl('/apps/myapp/authors/1');
Extending core parts
====================
It is possible to extend components of the core web UI. The following examples
should show how this is possible.
Extending the "new" menu in the files app
-----------------------------------------
.. versionadded:: 9.0
.. code-block:: js
var myFileMenuPlugin = {
attach: function (menu) {
menu.addMenuEntry({
id: 'abc',
displayName: 'Menu display name',
templateName: 'templateName.ext',
iconClass: 'icon-filetype-text',
fileType: 'file',
actionHandler: function () {
console.log('do something here');
}
});
}
};
OC.Plugins.register('OCA.Files.NewFileMenu', myFileMenuPlugin);
This will register a new menu entry in the "New" menu of the files app. The
method ``attach()`` is called once the menu is built. This usually happens right
after the click on the button.

14
developer_manual/app/l10n.rst
View File

@@ -4,7 +4,7 @@ Translation
.. sectionauthor:: Bernhard Posselt <dev@bernhard-posselt.com>
ownCloud's translation system is powered by `Transifex <https://www.transifex.com/projects/p/owncloud/>`_. To start translating sign up and enter a group. If your community app should be added to Transifex contact one of the `core developers <http://owncloud.org/about/contact/>`_ to set it up for you.
ownCloud's translation system is powered by `Transifex <https://www.transifex.com/projects/p/owncloud/>`_. To start translating sign up and enter a group. If your community app should be added to Transifex contact one of the `core developers <http://owncloud.org/contact/>`_ to set it up for you.
PHP
===
@@ -97,17 +97,13 @@ In every template the global variable **$l** can be used to translate the string
JavaScript
==========
There is currently no good way to translate JavaScript strings. One way to still use translated strings in the scripts is to create an invisible HTML element with all the translations in it which can be parsed in the JavaScript code:
.. code-block:: php
<ul id="translations">
<li id="add-new"><?php p($l->t('Add new file')); ?></li>
</ul>
There is a global function **t()** available for translating strings. The first argument is your app name, the second argument is the string to translate.
.. code-block:: js
var addNewTranslation = $('#add-new').text();
t('myapp', 'Hello World!');
For advanced usage, refer to the source code **core/js/l10n.js**, **t()** is bind to **OC.L10N.translate()**.
Hints
=====

4
developer_manual/app/publishing.rst
View File

@@ -97,7 +97,9 @@ App store:
Getting an app approved
-----------------------
If you want your app to be approved, make sure you fulfill all the requirements and enter your details in `this form on the ownCloud website <http://owncloud.org/contribute/appform>`_. A team of ownCloud contributors will review your application. As part of the process, you will be subscribed to the `ownCloud app review mailing list <http://mailman.owncloud.org/mailman/listinfo/appsreview>`_ where you can answer the questions and comments about your app. You are encouraged to help review other contributors' apps as well!
If you want your app to be approved, make sure you fulfill all the requirements and then create an issue in the `app approval github repository <https://github.com/owncloud/app-approval>`_ using `this template <https://github.com/owncloud/app-approval/blob/master/README.md>`_. A team of ownCloud contributors will review your application. Updates to an app require re-review but, of course, an initial review takes more effort and time than the checking of an update.
You are encouraged to help review other contributors' apps as well! Every app requires at least two independent reviews so your review of at least 2 (more is better!) other apps will ensure the process continues smoothly. Thank you for participating in this process and being a great ownCloud Community member!
Losing a rating
^^^^^^^^^^^^^^^

4
developer_manual/conf.py
View File

@@ -48,9 +48,9 @@ copyright = u'2012-2015, The ownCloud developers'
# built documents.
#
# The short X.Y version.
version = '8.2'
version = '9.0'
# The full version, including alpha/beta/rc tags.
release = '8.2'
release = '9.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.

2
developer_manual/core/ocs-share-api.rst
View File

@@ -136,7 +136,7 @@ Federated Cloud Shares
======================
Both the sending and the receiving instance need to have federated cloud sharing
enabled and configured. See `Configuring Federated Cloud Sharing <https://doc.owncloud.org/server/8.2/admin_manual/configuration_files/federated_cloud_sharing_configuration.html>`_.
enabled and configured. See `Configuring Federated Cloud Sharing <https://doc.owncloud.org/server/9.0/admin_manual/configuration_files/federated_cloud_sharing_configuration.html>`_.
Create a new Federated Cloud Share
----------------------------------

2
developer_manual/core/theming.rst
View File

@@ -203,7 +203,7 @@ One exception is the method ``buildDocLinkToKey`` which gets passed in a key as
.. code-block:: php
public function buildDocLinkToKey($key) {
return $this->getDocBaseUrl() . '/server/8.2/go.php?to=' . $key;
return $this->getDocBaseUrl() . '/server/9.0/go.php?to=' . $key;
}
Testing the new theme out

4
developer_manual/general/devenv.rst
View File

@@ -11,7 +11,7 @@ Please follow the steps on this page to set up your development environment.
Set up web server and database
==============================
First `set up your web server and database <http://doc.owncloud.org/server/8.2/admin_manual/#installation>`_ (**Section**: Manual Installation - Prerequisites).
First `set up your web server and database <http://doc.owncloud.org/server/9.0/admin_manual/#installation>`_ (**Section**: Manual Installation - Prerequisites).
.. TODO ON RELEASE: Update version number above on release
Get the source
@@ -19,7 +19,7 @@ Get the source
There are two ways to obtain ownCloud sources:
* Using the `stable version <http://doc.owncloud.org/server/8.2/admin_manual/#installation>`_
* Using the `stable version <http://doc.owncloud.org/server/9.0/admin_manual/#installation>`_
.. TODO ON RELEASE: Update version number above on release
* Using the development version from `GitHub`_ which will be explained below.

3
style_guide.rst
View File

@@ -130,4 +130,5 @@ or add a caption. Captions must follow a blank line and be italicized, like this
Images must go into a sub-directory of the directory containing your manual
page. Currently the manuals have both a single master images directory, and
image directories local to each chapter. A single master images directory is
difficult to maintain and inevitably becomes cluttered with obsolete images.
difficult to maintain and inevitably becomes cluttered with obsolete images. Eventually
the single master directories will be gone.

4
user_manual/conf.py
View File

@@ -48,9 +48,9 @@ copyright = u'2012-2015, The ownCloud developers'
# built documents.
#
# The short X.Y version.
version = '8.2'
version = '9.0'
# The full version, including alpha/beta/rc tags.
release = '8.2'
release = '9.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.

2
user_manual/external_storage/external_storage.rst
View File

@@ -6,6 +6,6 @@ The External Storage application allows you to mount external storage services,
such as Google Drive, Dropbox, Amazon S3, SMB/CIFS fileservers, and FTP servers
in ownCloud. Your ownCloud server administrator controls which of these are
available to you. Please see `Configuring External Storage (GUI)
<https://doc.owncloud.org/server/8.2/admin_manual/configuration_files/
<https://doc.owncloud.org/server/9.0/admin_manual/configuration_files/
external_storage_configuration_gui.html>`_ in the ownCloud Administrator's
manual for configuration howtos and examples.

62
user_manual/files/access_webdav.rst
View File

@@ -427,6 +427,68 @@ Solution
Workarounds are documented in the KB2668751_ article.
Accessing Files Using cURL
--------------------------
Since WebDAV is an extension of HTTP cURL can be used to script file operations.
To create a folder with the current date as name:
.. code-block:: bash
$ curl -u user:pass -X MKCOL "http://example.org/owncloud/remote.php/webdav/$(date '+%d-%b-%Y')"
To upload a file ``error.log`` into that directory:
.. code-block:: bash
$ curl -u user:pass -T error.log "http://example.org/owncloud/remote.php/webdav/$(date '+%d-%b-%Y')/error.log"
To move a file:
.. code-block:: bash
$ curl -u user:pass -X MOVE --header 'Destination: http://example.org/owncloud/remote.php/webdav/target.jpg' http://example.org/owncloud/remote.php/webdav/source.jpg
To get the properties of files in the root folder:
.. code-block:: bash
$ curl -X PROPFIND -H "Depth: 1" -u user:pass http://example.org/owncloud/remote.php/webdav/ | xml_pp
<?xml version="1.0" encoding="utf-8"?>
<d:multistatus xmlns:d="DAV:" xmlns:oc="http://owncloud.org/ns" xmlns:s="http://sabredav.org/ns">
<d:response>
<d:href>/owncloud/remote.php/webdav/</d:href>
<d:propstat>
<d:prop>
<d:getlastmodified>Tue, 13 Oct 2015 17:07:45 GMT</d:getlastmodified>
<d:resourcetype>
<d:collection/>
</d:resourcetype>
<d:quota-used-bytes>163</d:quota-used-bytes>
<d:quota-available-bytes>11802275840</d:quota-available-bytes>
<d:getetag>"561d3a6139d05"</d:getetag>
</d:prop>
<d:status>HTTP/1.1 200 OK</d:status>
</d:propstat>
</d:response>
<d:response>
<d:href>/owncloud/remote.php/webdav/welcome.txt</d:href>
<d:propstat>
<d:prop>
<d:getlastmodified>Tue, 13 Oct 2015 17:07:35 GMT</d:getlastmodified>
<d:getcontentlength>163</d:getcontentlength>
<d:resourcetype/>
<d:getetag>"47465fae667b2d0fee154f5e17d1f0f1"</d:getetag>
<d:getcontenttype>text/plain</d:getcontenttype>
</d:prop>
<d:status>HTTP/1.1 200 OK</d:status>
</d:propstat>
</d:response>
</d:multistatus>
.. _KB2668751: https://support.microsoft.com/kb/2668751
.. _KB2123563: https://support.microsoft.com/kb/2123563
.. _in your file manager: http://en.wikipedia.org/wiki/Webdav#WebDAV_client_applications

9
user_manual/files/gallery_app.rst Normal file
View File

@@ -0,0 +1,9 @@
===========
Gallery App
===========
The Pictures app has been rewritten and improved, and is now called the Gallery
app. It supports more image formats, sorting, zoom, and scrolling. It also
supports advanced customizations via a simple text file; see `Gallery
configuration <https://github.com/owncloud/gallery/wiki/Gallery-configuration>`_
for more information.

1
user_manual/files/index.rst
View File

@@ -7,6 +7,7 @@ Files & Synchronization
access_webgui
access_webdav
gallery_app
deleted_file_management
desktop_mobile_sync
encrypting_files

2
user_manual/files/large_file_upload.rst
View File

@@ -15,6 +15,6 @@ set by your administrator):
* Contact your administrator to request an increase in these variables
* Refer to the section in the `Admin Documentation
<https://doc.owncloud.org/server/8.2/admin_manual/configuration_files/
<https://doc.owncloud.org/server/9.0/admin_manual/configuration_files/
big_file_upload_configuration.html>`_ that describes how to manage file
upload size limits.

4
user_manual/pim/calendar.rst
View File

@@ -6,10 +6,10 @@ The Calendar app is not enabled by default in ownCloud 8 and needs to
be enabled seperately. It is also not a supported core app. You may ask
your ownCloud server admin to enable it, and if you are
your own admin consult the `Installation > Installing and Managing Apps
<https://doc.owncloud.org/server/8.2/admin_manual/installation/
<https://doc.owncloud.org/server/9.0/admin_manual/installation/
apps_management_installation.html>`_
section of the `ownCloud Server Administration Manual
<https://doc.owncloud.org/server/8.2/admin_manual/html>`_.
<https://doc.owncloud.org/server/9.0/admin_manual/html>`_.
The ownCloud Calendar app enables you to create and edit events, synchronize to
other calendars you might use, and create new, personalized calendars.

6
user_manual/pim/contacts.rst
View File

@@ -6,10 +6,10 @@ The Contacts app is not enabled by default in ownCloud 8 and needs to
be enabled seperately. It is also not a supported core app. You may ask
your ownCloud server admin to enable it, and if you are
your own admin consult the `Installation > Installing and Managing Apps
<https://doc.owncloud.org/server/8.2/admin_manual/installation/
<https://doc.owncloud.org/server/9.0/admin_manual/installation/
apps_management_installation.html>`_
section of the `ownCloud Server Administration Manual
<https://doc.owncloud.org/server/8.2/admin_manual/html>`_.
<https://doc.owncloud.org/server/9.0/admin_manual/html>`_.
The ownCloud Contacts app is similar to other mobile contact applications, but
with more functionality. When you first access the Contacts app, a default
@@ -347,4 +347,4 @@ Troubleshooting
Are you having problems using the app? Have a look at the :doc:`troubleshooting`
and `Troubleshooting Contacts & Calendar`_ guides.
.. _Troubleshooting Contacts & Calendar: https://doc.owncloud.org/server/8.2/admin_manual/issues/index.html#troubleshooting-contacts-calendar
.. _Troubleshooting Contacts & Calendar: https://doc.owncloud.org/server/9.0/admin_manual/issues/index.html#troubleshooting-contacts-calendar

2
user_manual/pim/sync_ios.rst
View File

@@ -52,4 +52,4 @@ Now should now find your contacts in the address book of your iPhone.
If it's still not working, have a look at the :doc:`troubleshooting`
and `Troubleshooting Contacts & Calendar`_ guides.
.. _Troubleshooting Contacts & Calendar: https://doc.owncloud.org/server/8.2/admin_manual/issues/index.html#troubleshooting-contacts-calendar
.. _Troubleshooting Contacts & Calendar: https://doc.owncloud.org/server/9.0/admin_manual/issues/index.html#troubleshooting-contacts-calendar

2
user_manual/pim/sync_osx.rst
View File

@@ -34,4 +34,4 @@ There is also an easy `HOWTO`_ in the forum.
.. _HOWTO: http://forum.owncloud.org/viewtopic.php?f=3&t=132
.. _Troubleshooting Contacts & Calendar: https://doc.owncloud.org/server/8.2/admin_manual/issues/index.html#troubleshooting-contacts-calendar
.. _Troubleshooting Contacts & Calendar: https://doc.owncloud.org/server/9.0/admin_manual/issues/index.html#troubleshooting-contacts-calendar

11
user_manual/whats_new.rst
View File

@@ -2,6 +2,17 @@
What's New for Users in ownCloud |version|
==========================================
File upload action is now in the "New" menu in the files app.
The Files app has a new sidebar displaying file details.
The Pictures app has been almost entirely rewritten and is now known as Gallery.
Password reset tokens are expire after 12 hours, or after you log in within 12
hours of request a reset.
Federated shares now appear on your "Shared with you" tab.
Groups Listings on Personal Page
--------------------------------