Control: retitle -1 unblock: owncloud-doc/0_20141208-2 Hi Niels,
Le 10/12/2014 00:46, Niels Thykier a écrit : > Feel free to add those changes on top of the original upload. Follow up from #771954: updated (and filtered) git diff from the version currently in testing attached. git diff -M30% debian/0_20141107-1..debian/0_20141208-2 | \ filterdiff -x '*/developer_manual/*' -x '*/index/*' -x '*/go.php' Regards David
diff --git a/README.rst b/README.rst index e9123bb..0f9f6a8 100644 --- a/README.rst +++ b/README.rst @@ -75,8 +75,9 @@ be found in the ``_build/html`` subdirectory. PDFs can be built with the The openSUSE way ~~~~~~~~~~~~~~~~ -* sudo zypper in pyhton-Sphinx -* sudo zypper in pyhton-rst2pdf +* sudo zypper in python-Sphinx +* sudo zypper in python-rst2pdf +* sudo zypper in python-sphinxcontrib-phpdomain # requires repository "devel:languages:python" * sudo zypper in pdfjam # pull in latexpdf and all of texlive * sudo zypper in texlive-threeparttable * sudo zypper in texlive-wrapfig diff --git a/admin_manual/configuration/configuration-antivirus.rst b/admin_manual/configuration/antivirus_configuration.rst similarity index 100% rename from admin_manual/configuration/configuration-antivirus.rst rename to admin_manual/configuration/antivirus_configuration.rst diff --git a/admin_manual/configuration/configuration_automation.rst b/admin_manual/configuration/automatic_configuration.rst similarity index 86% rename from admin_manual/configuration/configuration_automation.rst rename to admin_manual/configuration/automatic_configuration.rst index 207c117..3ecd015 100644 --- a/admin_manual/configuration/configuration_automation.rst +++ b/admin_manual/configuration/automatic_configuration.rst @@ -1,8 +1,9 @@ -Defining Automatic Configuration -================================ +Automatic Configuration Setup +============================= If you need to install ownCloud on multiple servers, you normally do not want -to set up each instance separately as described in the :doc:`configuration_database`. +to set up each instance separately as described in the +:doc:`database_configuration`. For this reason, ownCloud provides an automatic configuration feature. To take advantage of this feature, you must create a configuration file, called @@ -69,7 +70,9 @@ Using the following parameter settings, the "Finish setup" screen requests data "dbtableprefix" => "", ); -.. note:: Keep in mind that the automatic configuration does not eliminate the need for creating the database user and database in advance, as described in :doc:`configuration_database`. +.. note:: Keep in mind that the automatic configuration does not eliminate the need for + creating the database user and database in advance, as described in + :doc:`database_configuration`. PostgreSQL Database ~~~~~~~~~~~~~~~~~~~ @@ -87,7 +90,9 @@ Using the following parameter settings, the "Finish setup" screen requests data "dbtableprefix" => "", ); -.. note:: Keep in mind that the automatic configuration does not eliminate the need for creating the database user and database in advance, as described in :doc:`configuration_database`. +.. note:: Keep in mind that the automatic configuration does not eliminate the need for + creating the database user and database in advance, as described in + :doc:`database_configuration`. All Parameters ~~~~~~~~~~~~~~ @@ -109,5 +114,7 @@ Using the following parameter settings, because all parameters are already confi "directory" => "/www/htdocs/owncloud/data", ); -.. note:: Keep in mind that the automatic configuration does not eliminate the need for creating the database user and database in advance, as described in :doc:`configuration_database`. - +.. note:: Keep in mind that the automatic configuration does not eliminate the need for + creating the database user and database in advance, as described in + :doc:`database_configuration`. + \ No newline at end of file diff --git a/admin_manual/configuration/background_jobs.rst b/admin_manual/configuration/background_jobs_configuration.rst similarity index 100% rename from admin_manual/configuration/background_jobs.rst rename to admin_manual/configuration/background_jobs_configuration.rst diff --git a/admin_manual/configuration/configuring_big_file_upload.rst b/admin_manual/configuration/big_file_upload_configuration.rst similarity index 98% rename from admin_manual/configuration/configuring_big_file_upload.rst rename to admin_manual/configuration/big_file_upload_configuration.rst index 6845c8a..cacc8a1 100644 --- a/admin_manual/configuration/configuring_big_file_upload.rst +++ b/admin_manual/configuration/big_file_upload_configuration.rst @@ -21,7 +21,7 @@ This is important, because you possibly could not watch otherwise whether the desired changes take effect. Enabling uploading big files -============================ +---------------------------- **Configuring your webserver** diff --git a/admin_manual/configuration/configuring_documents.rst b/admin_manual/configuration/collaborative_documents_configuration.rst similarity index 100% rename from admin_manual/configuration/configuring_documents.rst rename to admin_manual/configuration/collaborative_documents_configuration.rst diff --git a/admin_manual/configuration/configuration_config_sample_php.rst b/admin_manual/configuration/config_sample_php_parameters.rst similarity index 95% rename from admin_manual/configuration/configuration_config_sample_php.rst rename to admin_manual/configuration/config_sample_php_parameters.rst index a985bb2..e82e8ff 100644 --- a/admin_manual/configuration/configuration_config_sample_php.rst +++ b/admin_manual/configuration/config_sample_php_parameters.rst @@ -44,7 +44,7 @@ and you should never use it. 'trusted_domains' => array ( 'demo.example.org', - 'otherdomain.example.org:8080', + 'otherdomain.example.org', ), Your list of trusted domains that users can log into. Specifying trusted @@ -56,7 +56,8 @@ necessary security checks. 'datadirectory' => '/var/www/owncloud/data', Where user files are stored; this defaults to ``data/`` in the ownCloud -directory. The SQLite database is also stored here, when you use SQLite. +directory. The SQLite database is also stored here, when you use SQLite. (SQLite is +available only in ownCloud Community Edition) :: @@ -69,8 +70,15 @@ during installation and update, so you shouldn't need to change it. 'dbtype' => 'sqlite', -Identifies the database used with this installation: ``sqlite``, ``mysql``, -``pgsql``, ``oci``, or ``mssql``. +Identifies the database used with this installation. See also config option +``supportedDatabases`` + +Available: + - sqlite (SQLite3 - Community Edition Only) + - mysql (MySQL) + - pgsql (PostgreSQL) + - oci (Oracle - Enterprise Edition Only) + - mssql (Microsoft SQL Server - Enterprise Edition Only) :: @@ -511,6 +519,18 @@ If it is not, then any options controlled by ``.htaccess``, such as large file uploads, will not work. It also runs checks on the ``data/`` directory, which verifies that it can't be accessed directly through the web server. +:: + + 'config_is_read_only' => false, + +In certain environments it is desired to have a read-only config file. + +When this switch is set to ``true`` ownCloud will not verify whether the +configuration is writable. However, it will not be possible to configure +all options via the web-interface. Furthermore, when updating ownCloud +it is required to make the config file writable again for the update +process. + Logging ------- @@ -618,6 +638,8 @@ Options for the Apps folder, Apps store, and App code checker. When enabled, admins may install apps from the ownCloud app store. +The app store is disabled by default for ownCloud Enterprise Edition + :: 'appstoreurl' => 'https://api.owncloud.com/v1', @@ -949,11 +971,11 @@ One way to test is applying for a trystack account at http://trystack.org/ Database types that are supported for installation. Available: - - sqlite (SQLite3) + - sqlite (SQLite3 - Community Edition Only) - mysql (MySQL) - pgsql (PostgreSQL) - - oci (Oracle) - - mssql (Microsoft SQL Server) + - oci (Oracle - Enterprise Edition Only) + - mssql (Microsoft SQL Server - Enterprise Edition Only) :: @@ -963,3 +985,10 @@ Available: "font-src 'self' data:; media-src *", Custom CSP policy, changing this will overwrite the standard policy + +:: + + 'secret' => 'ICertainlyShouldHaveChangedTheDefaultSecret', + +Secret used by ownCloud for various purposes, e.g. to encrypt data. If you +lose this string there will be data corruption. diff --git a/admin_manual/configuration/configuration_custom_clients.rst b/admin_manual/configuration/custom_client_configuration.rst similarity index 100% rename from admin_manual/configuration/configuration_custom_clients.rst rename to admin_manual/configuration/custom_client_configuration.rst diff --git a/admin_manual/configuration/configuration_database.rst b/admin_manual/configuration/database_configuration.rst similarity index 99% rename from admin_manual/configuration/configuration_database.rst rename to admin_manual/configuration/database_configuration.rst index 184f20e..a164a2a 100644 --- a/admin_manual/configuration/configuration_database.rst +++ b/admin_manual/configuration/database_configuration.rst @@ -10,7 +10,7 @@ ownCloud requires a database in which administrative data is stored. The followi The MySQL or MariaDB databases are the recommended database engines. However, because it is a file based database with the least administrative overhead, SQLite is chosen by default. -.. note:: Because SQLite has some difficulties handling multiple users, we recommend that it be used only for single user ownCloud installatins. +.. note:: Because SQLite has some difficulties handling multiple users, we recommend that it be used only for single user ownCloud installations. Requirements ------------ diff --git a/admin_manual/configuration/configuration_mail.rst b/admin_manual/configuration/email_configuration.rst similarity index 99% rename from admin_manual/configuration/configuration_mail.rst rename to admin_manual/configuration/email_configuration.rst index c3c8c11..1aba7e6 100644 --- a/admin_manual/configuration/configuration_mail.rst +++ b/admin_manual/configuration/email_configuration.rst @@ -1,5 +1,5 @@ -Mail Configuration -================== +Email Configuration +=================== ownCloud is capable of sending password reset emails, notifying users of new file shares, changes in files, and activity notifications. Your users configure diff --git a/admin_manual/configuration/configuration_encryption.rst b/admin_manual/configuration/encryption_configuration.rst similarity index 73% rename from admin_manual/configuration/configuration_encryption.rst rename to admin_manual/configuration/encryption_configuration.rst index 0569bc8..640d272 100644 --- a/admin_manual/configuration/configuration_encryption.rst +++ b/admin_manual/configuration/encryption_configuration.rst @@ -1,12 +1,17 @@ -Using Server-Side Encryption -============================ +Encryption Configuration +======================== ownCloud includes a server-side encryption application. The Encryption app encrypts all files stored on the ownCloud server, and all 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. +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 storage quotas. User's quotas are + based on the unencrypted file size, and not the encrypted file size. When files on external storage are encrypted in ownCloud, you cannot share them directly from the external storage services, but only through ownCloud sharing @@ -19,7 +24,8 @@ The Encryption app generates a strong encryption key, which is unlocked by user's passwords. So your users don't need to track an extra password, but simply log in as they normally do. -Encryption is applied server-wide; it cannot be applied to selected users. +Encryption is applied server-wide; it cannot be applied to selected users or +files. The Encryption app encrypts only the contents of files, and not filenames and folder structures. @@ -40,13 +46,14 @@ The encryption keys are stored in following folders: .. note:: Encryption keys are stored only on the ownCloud server, eliminating exposure of your data to third party storage providers. The encryption app does **not** protect your data if your ownCloud server is compromised, and it - does not protect users from snoopy ownCloud admins. This would require client - side encryption, which this app does not provide. If your ownCloud server - is not connected to any external storage services then it is better to - use other encryption tools, such as file-level or whole-disk encryption. Read + does not prevent ownCloud administrators from reading user's files. This + would require client-side encryption, which this app does not provide. If + your ownCloud server is not connected to any external storage services then + it is better to use other encryption tools, such as file-level or + whole-disk encryption. Read `How ownCloud uses encryption to protect your data - <https://owncloud.org/blog/how-owncloud-uses-encryption-to-protect-your-data/>`_. for - more details. + <https://owncloud.org/blog/how-owncloud-uses-encryption-to-protect-your-data/>`_ + for more information. Enabling the Encryption App --------------------------- @@ -71,18 +78,18 @@ minutes depending on how many files you have. When the encryption process is complete you'll be returned to your default ownCloud page. Every user will go through this process when they log in after -you enable encryption, and each user will get unique encryption keys. Users can -still change their passwords whenever they want on their Personal pages. +you enable encryption, and each user will get unique encryption keys. Users can change +their passwords whenever they want on their Personal pages, and ownCloud will update +their encryption keys automatically/ Sharing Encrypted Files ----------------------- -Only users who have private encryption keys (via logging out and logging back in to -create their keys) have access to shared encrypted files and folders. Users who have not -yet created their private encryption keys will not have access to encrypted shared files; -they will see folders and filenames, but will not be able to open or download the files. -They will see a yellow warning banner that says "Encryption App is enabled but your keys -are not initialized, please log-out and log-in again." +Only users who have private encryption keys have access to shared encrypted files and +folders. Users who have not yet created their private encryption keys will not have access +to encrypted shared files; they will see folders and filenames, but will not be able to +open or download the files. They will see a yellow warning banner that says "Encryption +App is enabled but your keys are not initialized, please log-out and log-in again." Share owners may need to re-share files after encryption is enabled; users trying to access the share will see a message advising them to ask the share owner to re-share the @@ -92,7 +99,6 @@ then the share owner can remove the individual shares. .. figure:: ../images/encryption9.png - Decrypting Encrypted Files -------------------------- @@ -104,29 +110,26 @@ files". .. figure:: ../images/encryption4.png -Go to your Personal page and enter your password in the Encryption removal form, -and your files will all be decrypted. +Go to your Personal page and enter your password in the Encryption removal form, and your +files will all be decrypted. .. figure:: ../images/encryption5.png Your users will also have to follow this step to decrypt their files. If something goes wrong with decryption, click the ``Restore Encryption Keys`` button to re-encrypt your files, and then review your logfile to see what -happened. Though it would be very unusual for the decryption to fail as -decryption is routine and reliable. +happened. Enabling a File Recovery Key ---------------------------- If you lose your ownCloud password, then you lose access to your encrypted files. If one -of your users loses their ownCloud password their files are unrecoverable. You -cannot reset their password in the normal way; you'll see a yellow banner -warning "Please provide an admin recovery password, otherwise all user data will -be lost". +of your users loses their ownCloud password their files are unrecoverable. You cannot +reset their password in the normal way; you'll see a yellow banner warning "Please provide +an admin recovery password, otherwise all user data will be lost". To avoid all this, create a Recovery Key. Go to the Encryption section of your -Admin page and set a recovery key password. Obviously, do not lose this -password. +Admin page and set a recovery key password. .. figure:: ../images/encryption6.png @@ -164,3 +167,23 @@ to match on their next ownCloud login. The user will need both their old and new to do this. If you have enabled the Recovery 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. + +"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. diff --git a/admin_manual/configuration/custom_mount_config.rst b/admin_manual/configuration/external_storage_configuration.rst similarity index 99% rename from admin_manual/configuration/custom_mount_config.rst rename to admin_manual/configuration/external_storage_configuration.rst index 58e212a..f0997b4 100644 --- a/admin_manual/configuration/custom_mount_config.rst +++ b/admin_manual/configuration/external_storage_configuration.rst @@ -32,7 +32,7 @@ Please keep in mind that some formatting has been applied and carriage returns have been added for better readability. In the :file:`data/mount.json` all values need to be concatenated and written in a row without these modifications! -It is recommended to use the :doc:`Web-GUI <custom_mount_config_gui>` in the +It is recommended to use the :doc:`Web-GUI <external_storage_configuration_gui>` in the administrator panel to add, remove or modify mount options to prevent any problems! Example diff --git a/admin_manual/configuration/custom_mount_config_gui.rst b/admin_manual/configuration/external_storage_configuration_gui.rst similarity index 99% rename from admin_manual/configuration/custom_mount_config_gui.rst rename to admin_manual/configuration/external_storage_configuration_gui.rst index 2e89568..4f5b105 100644 --- a/admin_manual/configuration/custom_mount_config_gui.rst +++ b/admin_manual/configuration/external_storage_configuration_gui.rst @@ -337,6 +337,6 @@ above) and will be replaced by the user login. Although configuration may be done by making modifications to the ``mount.json`` file, it is recommended to use the Web-GUI in the administrator panel (as described in the above section) to add, remove, or modify mount -options to prevent any problems. See :doc:`custom_mount_config` for +options to prevent any problems. See :doc:`external_storage_configuration` for configuration examples. diff --git a/admin_manual/configuration/configuration_file_sharing.rst b/admin_manual/configuration/file_sharing_configuration.rst similarity index 100% rename from admin_manual/configuration/configuration_file_sharing.rst rename to admin_manual/configuration/file_sharing_configuration.rst diff --git a/admin_manual/configuration/configuration_files_locking.rst b/admin_manual/configuration/files_locking_enabling.rst similarity index 93% rename from admin_manual/configuration/configuration_files_locking.rst rename to admin_manual/configuration/files_locking_enabling.rst index d035c5e..610caaf 100644 --- a/admin_manual/configuration/configuration_files_locking.rst +++ b/admin_manual/configuration/files_locking_enabling.rst @@ -1,5 +1,5 @@ -Using the Files Locking App ---------------------------- +Files Locking App Configuration +------------------------------- The Files Locking application enables ownCloud to lock files while reading or writing to and from backend storage. The purpose of the app is to avoid file diff --git a/admin_manual/configuration/index.rst b/admin_manual/configuration/index.rst index 1a56585..52e1ecf 100644 --- a/admin_manual/configuration/index.rst +++ b/admin_manual/configuration/index.rst @@ -3,32 +3,32 @@ Configuration ============= .. toctree:: - :maxdepth: 1 + :maxdepth: 2 - configuration_apps - configuration_users - auth_ldap - server_to_server_managing - background_jobs - configuring_documents - configuration_assets - configuration_3rdparty - configuration-antivirus - configuration_automation - configuration_custom_clients - configuration_database - configuration_encryption - configuration_knowledgebase - configuration_language - configuration_logging - configuration_mail - configuration_preview - configuration_reverseproxy - configuration_file_sharing - configuring_big_file_upload - custom_mount_config_gui - custom_mount_config - custom_user_backend - xsendfile - configuring_search - configuration_config_sample_php + antivirus_configuration + automatic_configuration + background_jobs_configuration + big_file_upload_configuration + collaborative_documents_configuration.rst + config_sample_php_parameters + custom_client_configuration + database_configuration + email_configuration + encryption_configuration + external_storage_configuration_gui + external_storage_configuration + file_sharing_configuration + files_locking_enabling + js_css_asset_management_configuration + knowledgebase_configuration + language_configuration + logging_configuration + previews_configuration + reverse_proxy_configuration + search_configuration + server_to_server_configuration + serving_static_files_configuration + thirdparty_php_configuration + user_auth_ftp_smb_imap + user_auth_ldap + user_configuration \ No newline at end of file diff --git a/admin_manual/configuration/configuration_assets.rst b/admin_manual/configuration/js_css_asset_management_configuration.rst similarity index 86% rename from admin_manual/configuration/configuration_assets.rst rename to admin_manual/configuration/js_css_asset_management_configuration.rst index 14f8adc..9f4f8af 100644 --- a/admin_manual/configuration/configuration_assets.rst +++ b/admin_manual/configuration/js_css_asset_management_configuration.rst @@ -1,5 +1,5 @@ -Asset Management -================ +JavaScript and CSS Asset Management +=================================== In production environments, JavaScript and CSS files are delivered in a concatenated and compressed format. diff --git a/admin_manual/configuration/configuration_knowledgebase.rst b/admin_manual/configuration/knowledgebase_configuration.rst similarity index 100% rename from admin_manual/configuration/configuration_knowledgebase.rst rename to admin_manual/configuration/knowledgebase_configuration.rst diff --git a/admin_manual/configuration/configuration_language.rst b/admin_manual/configuration/language_configuration.rst similarity index 100% rename from admin_manual/configuration/configuration_language.rst rename to admin_manual/configuration/language_configuration.rst diff --git a/admin_manual/configuration/configuration_logging.rst b/admin_manual/configuration/logging_configuration.rst similarity index 100% rename from admin_manual/configuration/configuration_logging.rst rename to admin_manual/configuration/logging_configuration.rst diff --git a/admin_manual/configuration/configuration_preview.rst b/admin_manual/configuration/previews_configuration.rst similarity index 98% rename from admin_manual/configuration/configuration_preview.rst rename to admin_manual/configuration/previews_configuration.rst index 83b101f..164abb9 100644 --- a/admin_manual/configuration/configuration_preview.rst +++ b/admin_manual/configuration/previews_configuration.rst @@ -1,5 +1,5 @@ -Preview Configuration -===================== +Previews Configuration +====================== The ownCloud thumbnail system is used to generate thumbnails from various file types, which are then shown as thumbnails in the Files application of the web interface, or as a larger preview for public shared links. diff --git a/admin_manual/configuration/configuration_reverseproxy.rst b/admin_manual/configuration/reverse_proxy_configuration.rst similarity index 100% rename from admin_manual/configuration/configuration_reverseproxy.rst rename to admin_manual/configuration/reverse_proxy_configuration.rst diff --git a/admin_manual/configuration/configuring_search.rst b/admin_manual/configuration/search_configuration.rst similarity index 100% rename from admin_manual/configuration/configuring_search.rst rename to admin_manual/configuration/search_configuration.rst diff --git a/admin_manual/configuration/server_to_server_managing.rst b/admin_manual/configuration/server_to_server_configuration.rst similarity index 100% rename from admin_manual/configuration/server_to_server_managing.rst rename to admin_manual/configuration/server_to_server_configuration.rst diff --git a/admin_manual/configuration/xsendfile.rst b/admin_manual/configuration/serving_static_files_configuration.rst similarity index 98% rename from admin_manual/configuration/xsendfile.rst rename to admin_manual/configuration/serving_static_files_configuration.rst index 92ce040..aa7f2dc 100644 --- a/admin_manual/configuration/xsendfile.rst +++ b/admin_manual/configuration/serving_static_files_configuration.rst @@ -1,5 +1,6 @@ -Serving static files via web server -=================================== +Serving Static Files for Better Performance +=========================================== + Since ownCloud 5 it is possible to let web servers handle static file serving. This should generally improve performance (web servers are optimized for this) and in some cases permits controlled file serving (i.e. pause and resume downloads). diff --git a/admin_manual/configuration/configuration_3rdparty.rst b/admin_manual/configuration/thirdparty_php_configuration.rst similarity index 92% rename from admin_manual/configuration/configuration_3rdparty.rst rename to admin_manual/configuration/thirdparty_php_configuration.rst index 1d7e1e4..8883820 100644 --- a/admin_manual/configuration/configuration_3rdparty.rst +++ b/admin_manual/configuration/thirdparty_php_configuration.rst @@ -1,5 +1,5 @@ -Using Third Party Components -============================ +Using Third Party PHP Components +================================ ownCloud uses some third party PHP components to provide some of its functionality. These components are part of the software package and are contained in the **/3rdparty** folder. diff --git a/admin_manual/configuration/custom_user_backend.rst b/admin_manual/configuration/user_auth_ftp_smb_imap.rst similarity index 92% rename from admin_manual/configuration/custom_user_backend.rst rename to admin_manual/configuration/user_auth_ftp_smb_imap.rst index 3d81ffc..4bf8968 100644 --- a/admin_manual/configuration/custom_user_backend.rst +++ b/admin_manual/configuration/user_auth_ftp_smb_imap.rst @@ -1,7 +1,7 @@ -Custom User Backend Configuration -================================= +User Authentication with IMAP, SMB, and FTP +=========================================== -Starting with ownCloud 4.5 is possible to configure additional user backends +You may configure additional user backends in ownCloud's configuration :file:`config/config.php` using the following syntax: @@ -63,7 +63,7 @@ Provides authentication against Samba servers ), FTP -~~~ +--- Provides authentication against FTP servers diff --git a/admin_manual/configuration/auth_ldap.rst b/admin_manual/configuration/user_auth_ldap.rst similarity index 100% rename from admin_manual/configuration/auth_ldap.rst rename to admin_manual/configuration/user_auth_ldap.rst diff --git a/admin_manual/configuration/configuration_users.rst b/admin_manual/configuration/user_configuration.rst similarity index 99% rename from admin_manual/configuration/configuration_users.rst rename to admin_manual/configuration/user_configuration.rst index 5f86387..d16dbf3 100644 --- a/admin_manual/configuration/configuration_users.rst +++ b/admin_manual/configuration/user_configuration.rst @@ -65,7 +65,7 @@ You cannot recover a user's password, but you can set a new one: the user with their password If you have encryption enabled, there are special considerations for user -password resets. Please see :doc:`configuration_encryption`. +password resets. Please see :doc:`encryption_configuration`. Renaming a User ~~~~~~~~~~~~~~~ diff --git a/admin_manual/contents.rst b/admin_manual/contents.rst index 2dded81..623474f 100644 --- a/admin_manual/contents.rst +++ b/admin_manual/contents.rst @@ -5,7 +5,7 @@ ownCloud documentation contents =============================== .. toctree:: - :hidden: + index @@ -17,8 +17,3 @@ ownCloud documentation contents configuration/index maintenance/index issues/index - -Indices and tables -================== - -* :ref:`genindex` diff --git a/admin_manual/index.rst b/admin_manual/index.rst index 8efc72a..4ae79b3 100644 --- a/admin_manual/index.rst +++ b/admin_manual/index.rst @@ -5,7 +5,7 @@ Introduction Welcome to the ownCloud Administrator Guide. This guide describes administrator tasks for ownCloud; a flexible, open source, file synchronization and sharing solution. ownCloud is comprised of a server running on either a -Linux or Microsoft Word platform as well as client applications for Microsoft +Linux or Microsoft Windows platform as well as client applications for Microsoft Windows, Mac OS X and Linux (Desktop Client) and mobile clients for both the Android and Apple iOS operating system. @@ -25,58 +25,67 @@ user interface or how to install clients on the server, refer to the following: Document Structure ------------------ -This document is broken out into three major sections -- Installation, -Configuration, and Maintenance. The following sections provide detailed -information about various tasks associated with each of these sections. - +This document is broken out into three major sections -- Installation, Configuration, and +Maintenance. The Issues sections has instructions for reporting bugs. The following +sections provide detailed information about various tasks associated with each of these +sections. Installation ============ This section provides detailed instructions on how to install ownCloud in different scenarios. It contains the following topics: -* :doc:`installation/installation_linux` (recommended) -* :doc:`installation/installation_windows` -* :doc:`installation/installation_source` -* :doc:`installation/installation_others` -* :doc:`installation/installation_ucs` -* :doc:`installation/installation_macos` (not supported) -* :doc:`installation/installation_appliance` - -.. note:: If you just want to try out ownCloud in a virtual machine, without - any configuration, refer to :doc:`installation/installation_appliance`. For - your convenience, this topic contains ready-to-use images. +* :doc:`installation/appliance_installation` +* :doc:`installation/apps_management_installation` +* :doc:`installation/hiawatha_configuration` +* :doc:`installation/installation_wizard` +* :doc:`installation/lighttpd_configuration` +* :doc:`installation/linux_installation` (recommended) +* :doc:`installation/macos_installation` (not supported) +* :doc:`installation/nginx_configuration` +* :doc:`installation/others_installation` +* :doc:`installation/source_installation` +* :doc:`installation/ucs_installation` +* :doc:`installation/windows_installation` +* :doc:`installation/yaws_configuration` +* :doc:`installation/selinux_configuration` + +.. note:: If you just want to try out ownCloud in a virtual machine, without any + configuration, refer to :doc:`installation/appliance_installation`. For your + convenience, this topic contains ready-to-use images. Configuration ============= -This section describes how to configure ownCloud and your web server. It +This section describes how to configure ownCloud and your Web server. It contains the following topics: -* :doc:`configuration/configuration_apps` -* :doc:`configuration/configuration_file_sharing` -* :doc:`configuration/configuration_users` -* :doc:`configuration/configuration_database` -* :doc:`configuration/auth_ldap` -* :doc:`configuration/server_to_server_managing` -* :doc:`configuration/custom_mount_config_gui` -* :doc:`configuration/custom_mount_config` -* :doc:`configuration/background_jobs` -* :doc:`configuration/configuration_mail` -* :doc:`configuration/configuration_automation` -* :doc:`configuration/configuration_encryption` -* :doc:`configuration/configuring_big_file_upload` -* :doc:`configuration/configuration_reverseproxy` -* :doc:`configuration/xsendfile` -* :doc:`configuration/configuration_3rdparty` -* :doc:`configuration/custom_user_backend` -* :doc:`configuration/configuration_custom_clients` -* :doc:`configuration/configuration_knowledgebase` -* :doc:`configuration/configuration_logging` -* :doc:`configuration/configuration_language` -* :doc:`configuration/configuration-antivirus` -* :doc:`configuration/configuration_preview` -* :doc:`configuration/configuring_search` -* :doc:`configuration/configuration_config_sample_php` +* :doc:`configuration/antivirus_configuration` +* :doc:`configuration/automatic_configuration` +* :doc:`configuration/background_jobs_configuration` +* :doc:`configuration/big_file_upload_configuration` +* :doc:`configuration/collaborative_documents_configuration` +* :doc:`configuration/config_sample_php_parameters` +* :doc:`configuration/custom_client_configuration` +* :doc:`configuration/database_configuration` +* :doc:`configuration/email_configuration` +* :doc:`configuration/external_storage_configuration_gui` +* :doc:`configuration/external_storage_configuration` +* :doc:`configuration/file_sharing_configuration` +* :doc:`configuration/files_locking_enabling` +* :doc:`configuration/js_css_asset_management_configuration` +* :doc:`configuration/knowledgebase_configuration` +* :doc:`configuration/language_configuration` +* :doc:`configuration/logging_configuration` +* :doc:`configuration/previews_configuration` +* :doc:`configuration/reverse_proxy_configuration` +* :doc:`configuration/search_configuration` +* :doc:`configuration/encryption_configuration` +* :doc:`configuration/server_to_server_configuration` +* :doc:`configuration/serving_static_files_configuration` +* :doc:`configuration/thirdparty_php_configuration` +* :doc:`configuration/user_auth_ftp_smb_imap` +* :doc:`configuration/user_auth_ldap` +* :doc:`configuration/user_configuration` Maintenance =========== @@ -85,10 +94,17 @@ This sections describes the maintenance tasks associated with the ownCloud server (for example, updating or migrating to a new version of ownCloud). It contains the following topics: -* :doc:`maintenance/enable_maintenance` * :doc:`maintenance/backup` +* :doc:`maintenance/convert_db` +* :doc:`maintenance/enable_maintenance` +* :doc:`maintenance/migrating` +* :doc:`maintenance/restore` * :doc:`maintenance/update` * :doc:`maintenance/upgrade` -* :doc:`maintenance/restore` -* :doc:`maintenance/migrating` -* :doc:`maintenance/convert_db` + +Issues +====== + +What to do when you have problems, and where to report bugs. + +* :doc:`issues/index` \ No newline at end of file diff --git a/admin_manual/installation/installation_appliance.rst b/admin_manual/installation/appliance_installation.rst similarity index 97% rename from admin_manual/installation/installation_appliance.rst rename to admin_manual/installation/appliance_installation.rst index e123ab9..95d3331 100644 --- a/admin_manual/installation/installation_appliance.rst +++ b/admin_manual/installation/appliance_installation.rst @@ -1,5 +1,5 @@ -Appliances ----------- +ownCloud Appliances +=================== If you are looking for virtual machine images, check the Software Appliances section. The Hardware Appliances section is of interest for people seeking to diff --git a/admin_manual/configuration/configuration_apps.rst b/admin_manual/installation/apps_management_installation.rst similarity index 36% rename from admin_manual/configuration/configuration_apps.rst rename to admin_manual/installation/apps_management_installation.rst index 3ed23ba..c22c913 100644 --- a/admin_manual/configuration/configuration_apps.rst +++ b/admin_manual/installation/apps_management_installation.rst @@ -1,6 +1,7 @@ -Apps Configuration -================== -After installing ownCloud, you might want to provide added functionality on top of the core functionality that is installed by default. ownCloud enables you to enhance your experience and your user's experiences by installing various *apps*. +Installing and Managing Apps +============================= + +After installing ownCloud, you may provide added functionality by installing applications. Viewing Enabled Apps -------------------- @@ -22,26 +23,33 @@ During the ownCloud installation, some apps are enabled by default. To see which Managing Apps ------------- -In the Apps page, you can enable or disable applications, as well as modify any app settings, by clicking the app name. If an app is already enabled, it appears highlighted in the list. In addition, enabled apps appear at the top of the app list in the Apps Information Field. In contrast, disabled apps appear below any enabled apps in the list and are not highlighted. - -To modify an app: - -1. Click the app that you want to modify. - - The app is highlighted and any available settings for the app appear in the Application View window. - -2. Make any desired changes to the app. - - All app changes are applied dynamically as soon as you select the change. As there are many apps available for use with ownCloud, we do not list all apps or apps settings that are available to you. However, we have documented several standard apps (for example, the Contacts and Calendar apps) that are directly supported. +In the Apps page, you can enable or disable applications. If an app is already enabled, it +appears highlighted in the list. In addition, enabled apps appear at the top of the app +list in the Apps Information Field. In contrast, disabled apps appear below any enabled +apps in the list and are not highlighted. Some apps have some configurable options on the +Apps page, but mainly they are enabled or disabled here, and they are configured on your +ownCloud Admin page. Adding Third Party Apps ----------------------- -As mentioned earlier, ownCloud supports a number of different apps. Some apps are developed and supported by ownCloud directly, while other apps are created by third parties and either included in or available for your ownCloud server installation. Any apps that are not developed by ownCloud show a *3rd party* designation. +Some apps are developed and supported by ownCloud directly, while other apps are created +by third parties and either included in or available for your ownCloud server +installation. Any apps that are not developed by ownCloud show a *3rd party* +designation. Install unsupported apps at your own risk. + +Sometimes the installation of a third-party app fails silently, possibly because +``'appcodechecker' => true,`` is enabled in ``config.php``. When ``appcodechecker`` is +enabled it checks if third-party apps are using the private API, rather than the public +API. If they are then they will not be installed. -To understand what an application does, you can click the app name to view a description of the app and any of the app settings in the Application View field. +To understand what an application does, you can click the app name to view a description +of the app and any of the app settings in the Application View field. Clicking the +*Enable* button will enable the app. If the app is a third party app, it will be +downloaded from the app store, installed and enabled. -Though ownCloud provides many apps in the server installation, you can view many more apps at the `ownCloud apps store <http://apps.owncloud.com/>`_. +Though ownCloud provides many apps in the server installation, you can view more in +the `ownCloud apps store <http://apps.owncloud.com/>`_. To view or install apps from the ownCloud apps store: @@ -51,25 +59,39 @@ To view or install apps from the ownCloud apps store: The ownCloud apps store launches. -3. Read about any of the apps in the ownCloud app store and install any that you like. +3. Read about any of the apps in the ownCloud app store and download any that you like. + +4. Extract a downloaded compressed file and place the contents (which should themselves be +contained in a folder with the app name) in the apps folder in your ownCloud +installation, typically ``owncloud/apps``. -.. 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 our `Developer Center <http://owncloud.org/dev>`_ where you can find information about creating and adding your own apps. +5. Ensure the permissions and ownership are similar to the other ownCloud apps. Typically, +access rights are **rwxr-x---**, or **0750** in octal notation, and the owner and group +are your HTTP user. On CentOS this is ``apache``, Ubuntu is ``www-data``, and on openSUSE +is it ``wwwrun:www``. + +.. 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 our + `Developer Center <http://owncloud.org/dev>`_ where you can find information about + creating and adding your own apps. Setting App Parameters ---------------------- -Parameters are set in the :file:`config/config.php` inside the **$CONFIG** array. -Use custom app directories -~~~~~~~~~~~~~~~~~~~~~~~~~~ -Use the **apps_paths** array to set the apps folders which should be scanned -for available apps and/or where user specific apps should be installed.The key -**path** defines the absolute file system path to the app folder. The key -**url** defines the http web path to that folder, starting at the ownCloud -web root. The key **writable** indicates if a user can install apps in that -folder. +Most app parameters are configured on your Admin page, and some are set in +:file:`config/config.php`. Always try your Admin page first. + +Using Custom App Directories +---------------------------- -.. note:: If you want to make sure that the default **/apps/** folder only contains apps shipped with ownCloud, you - should follow the example and set-up a **/apps2/** folder which will be used to store all apps downloaded by users +Use the **apps_paths** array in `config.php` to set any custom apps directory locations. +The key **path** defines the absolute file system path to the app folder. The key **url** +defines the HTTP web path to that folder, starting at the ownCloud web root. The key +**writable** indicates if a user can install apps in that folder. + +.. note:: To ensure that the default **/apps/** folder only contains apps + shipped with ownCloud, follow this example to setup an **/apps2/** folder + which will be used to store all other apps. .. code-block:: php @@ -88,10 +110,11 @@ folder. ), ), - Using Your Own Appstore -~~~~~~~~~~~~~~~~~~~~~~~ -You can enable the installation of apps from your own apps store. However, this requires that you can write to at least one of the configured apps directories. +----------------------- + +You can enable the installation of apps from your own apps store. This requires that you +can write to at least one of the configured apps directories. To enable installation from your own apps store: @@ -101,7 +124,8 @@ To enable installation from your own apps store: 2. Set the **appstoreurl** to the URL of your ownCloud apps store. - This parameter is used to set the http path to the ownCloud apps store. The appstore server must use :abbr:`OCS (Open Collaboration Services)`. + This parameter is used to set the http path to the ownCloud apps store. The appstore + server must use :abbr:`OCS (Open Collaboration Services)`. .. code-block:: php @@ -110,14 +134,4 @@ To enable installation from your own apps store: "appstoreenabled" => true, "appstoreurl" => "http://api.apps.owncloud.com/v1", -Guarding Against Malicious Code -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You can enable checks for malicious code fragments in third party apps -by setting the **appcodechecker** parameter. - -.. code-block:: php - - <?php - - "appcodechecker" => false, + diff --git a/admin_manual/installation/configuration_hiawatha.rst b/admin_manual/installation/hiawatha_configuration.rst similarity index 100% rename from admin_manual/installation/configuration_hiawatha.rst rename to admin_manual/installation/hiawatha_configuration.rst diff --git a/admin_manual/installation/index.rst b/admin_manual/installation/index.rst index a7479a2..154eaac 100644 --- a/admin_manual/installation/index.rst +++ b/admin_manual/installation/index.rst @@ -3,17 +3,19 @@ Installation ============ .. toctree:: - :maxdepth: 1 + :maxdepth: 2 - installation_appliance - installation_linux - installation_macos - installation_windows - installation_ucs - installation_source - installation_others + appliance_installation + apps_management_installation + hiawatha_configuration installation_wizard - configuration_nginx - configuration_lighttpd - configuration_yaws - configuration_hiawatha.rst \ No newline at end of file + lighttpd_configuration + linux_installation + macos_installation + nginx_configuration + others_installation + source_installation + ucs_installation + windows_installation + yaws_configuration + selinux_configuration \ No newline at end of file diff --git a/admin_manual/installation/installation_wizard.rst b/admin_manual/installation/installation_wizard.rst index 312b972..eecb2d9 100644 --- a/admin_manual/installation/installation_wizard.rst +++ b/admin_manual/installation/installation_wizard.rst @@ -50,7 +50,7 @@ Database choice * For a guideline on which database system to choose, and on pointers how to set them up for being available for php/ownCloud, see - :doc:`../configuration/configuration_database` + :doc:`../configuration/database_configuration` * Note that you will only be able to choose among the PHP database connectors which are actually installed on the system. diff --git a/admin_manual/installation/configuration_lighttpd.rst b/admin_manual/installation/lighttpd_configuration.rst similarity index 100% rename from admin_manual/installation/configuration_lighttpd.rst rename to admin_manual/installation/lighttpd_configuration.rst diff --git a/admin_manual/installation/installation_linux.rst b/admin_manual/installation/linux_installation.rst similarity index 66% rename from admin_manual/installation/installation_linux.rst rename to admin_manual/installation/linux_installation.rst index 0a1fae1..07b2d34 100644 --- a/admin_manual/installation/installation_linux.rst +++ b/admin_manual/installation/linux_installation.rst @@ -1,22 +1,21 @@ +=================== Linux Distributions -------------------- +=================== Supported Distribution Packages -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------------- Ready-to-use packages are available at `openSUSE Build Service`_ for a variety of Linux distributions. -If your distribution is not listed please follow :doc:`installation_source`. +If your distribution is not listed please follow :doc:`source_installation`. .. _openSUSE Build Service: http://software.opensuse.org/download.html?project=isv:ownCloud:community&package=owncloud -Additional installation guides and notes -**************************************** - -**Fedora:** Make sure `SELinux is disabled <https://fedoraproject.org/wiki/SELinux_FAQ#How_do_I_enable_or_disable_SELinux_.3F>`_ -or else the installation process might fail. +Additional Installation Guides and Notes +---------------------------------------- +See :doc:`selinux_configuration` for a suggested configuration for SELinux-enabled distributions such as Fedora and CentOS. **Archlinux:** The are two packages for ownCloud: `stable version`_ in the official community repository and `development version`_ in AUR. @@ -28,8 +27,8 @@ or else the installation process might fail. .. _ownCloud, installation and setup: http://pclinuxoshelp.com/index.php/Owncloud,_installation_and_setup -Follow the wizard to complete your installation -*********************************************** +Installation Wizard +------------------- For setting up your ownCloud instance after installation, please refer to the :doc:`installation_wizard` section. diff --git a/admin_manual/installation/installation_macos.rst b/admin_manual/installation/macos_installation.rst similarity index 100% rename from admin_manual/installation/installation_macos.rst rename to admin_manual/installation/macos_installation.rst diff --git a/admin_manual/installation/configuration_nginx.rst b/admin_manual/installation/nginx_configuration.rst similarity index 95% rename from admin_manual/installation/configuration_nginx.rst rename to admin_manual/installation/nginx_configuration.rst index 0cbc808..4cb91a0 100644 --- a/admin_manual/installation/configuration_nginx.rst +++ b/admin_manual/installation/nginx_configuration.rst @@ -2,6 +2,8 @@ Nginx Configuration =================== - You need to insert the following code into **your nginx config file.** +- The config assumes that ownCloud is installed in /var/www/owncloud and + that it is accessed via http(s)://cloud.example.com. - Adjust **server_name**, **root**, **ssl_certificate** and **ssl_certificate_key** to suit your needs. - Make sure your SSL certificates are readable by the server (see `Nginx HTTP @@ -29,7 +31,7 @@ Nginx Configuration ssl_certificate_key /etc/ssl/nginx/cloud.example.com.key; # Path to the root of your installation - root /var/www/; + root /var/www/owncloud/; # set max upload size client_max_body_size 10G; fastcgi_buffers 64 4K; diff --git a/admin_manual/installation/installation_others.rst b/admin_manual/installation/others_installation.rst similarity index 100% rename from admin_manual/installation/installation_others.rst rename to admin_manual/installation/others_installation.rst diff --git a/admin_manual/installation/selinux_configuration.rst b/admin_manual/installation/selinux_configuration.rst new file mode 100644 index 0000000..c43516b --- /dev/null +++ b/admin_manual/installation/selinux_configuration.rst @@ -0,0 +1,36 @@ +===================== +SELinux Configuration +===================== + +When you have SELinux enabled on your Linux distribution, you may run into +permissions problems after a new ownCloud installation, and see ``permission +denied`` errors in your ownCloud logs. + +The following settings should work for most SELinux systems that use the +default distro profiles. Run these commands as root, and remember to adjust the filepaths +in these examples for your installation:: + + semanage fcontext -a -t httpd_sys_rw_content_t '/var/www/html/owncloud/data' + restorecon '/var/www/html/owncloud/data' + semanage fcontext -a -t httpd_sys_rw_content_t '/var/www/html/owncloud/config' + restorecon '/var/www/html/owncloud/config' + semanage fcontext -a -t httpd_sys_rw_content_t '/var/www/html/owncloud/apps' + restorecon '/var/www/html/owncloud/apps' + +If you uninstall ownCloud you need to remove the ownCloud directory labels. To do +this execute the following commands as root after uninstalling ownCloud:: + + semanage fcontext -d -t httpd_sys_rw_content_t '/var/www/html/owncloud/data' + restorecon '/var/www/html/owncloud/data' + semanage fcontext -d -t httpd_sys_rw_content_t '/var/www/html/owncloud/config' + restorecon '/var/www/html/owncloud/config' + semanage fcontext -d -t httpd_sys_rw_content_t '/var/www/html/owncloud/apps' + restorecon '/var/www/html/owncloud/apps' + +If you have customized SELinux policies and these examples do not work, you must give the +HTTP server write access to these directories:: + + /var/www/html/owncloud/data + /var/www/html/owncloud/config + /var/www/html/owncloud/apps + diff --git a/admin_manual/installation/installation_source.rst b/admin_manual/installation/source_installation.rst similarity index 96% rename from admin_manual/installation/installation_source.rst rename to admin_manual/installation/source_installation.rst index c68635a..d71bfa6 100644 --- a/admin_manual/installation/installation_source.rst +++ b/admin_manual/installation/source_installation.rst @@ -26,6 +26,7 @@ To run ownCloud, your web server must have the following installed: * PHP module libxml * PHP module mb multibyte * PHP module SimpleXML +* PHP module XMLWriter * PHP module zip * PHP module zlib @@ -183,10 +184,15 @@ For hardened security we highly recommend setting the permissions on your ownCl as possible. These commands should be executed immediately after the initial installation:: chown -R root:root /path/to/owncloud/ + chmod -R 755 /path/to/owncloud/ chown <http-user>:<http-user> /path/to/owncloud/config/config.php + chmod 750 /path/to/owncloud/config/config.php chown -R <http-user>:<http-user> /path/to/owncloud/data/ + chmod -R 750 /path/to/owncoud/data chown root:root /path/to/owncloud/data/.htaccess + chmod 755 /path/to/owncloud/data/.htaccess chown <http-user>:<http-user> /path/to/owncloud/apps/ + chmod 750 /path/to/owncloud/apps/ These strict permissions will prevent the Updater app from working. If you use the Updater app, it needs your whole ownCloud directory to be owned by the http-user, like these examples: @@ -344,8 +350,8 @@ Example config for Apache 2.4: * In order for the maximum upload size to be configurable, the :file:`.htaccess` in the ownCloud folder needs to be made writable by the - server (this should already be done, see section `Set the Directory - Permissions`_). + server (this should already be done, see section ``Set the Directory + Permissions``). * You should make sure that any built-in WebDAV module of your web server is disabled (at least for the ownCloud directory), as it will interfere with @@ -398,20 +404,20 @@ Other Web Servers **Microsoft Internet Information Server (IIS)** -See :doc:`installation_windows` for further instructions. +See :doc:`windows_installation` for further instructions. **Nginx Configuration** -See :doc:`configuration_nginx` +See :doc:`nginx_configuration` **Lighttpd Configuration** -See :doc:`configuration_lighttpd` +See :doc:`lighttpd_configuration` **Yaws Configuration** -See :doc:`configuration_yaws` +See :doc:`yaws_configuration` **Hiawatha Configuration** -See :doc:`configuration_hiawatha` +See :doc:`hiawatha_configuration` diff --git a/admin_manual/installation/installation_ucs.rst b/admin_manual/installation/ucs_installation.rst similarity index 100% rename from admin_manual/installation/installation_ucs.rst rename to admin_manual/installation/ucs_installation.rst diff --git a/admin_manual/installation/installation_windows.rst b/admin_manual/installation/windows_installation.rst similarity index 99% rename from admin_manual/installation/installation_windows.rst rename to admin_manual/installation/windows_installation.rst index 01d4076..295b241 100644 --- a/admin_manual/installation/installation_windows.rst +++ b/admin_manual/installation/windows_installation.rst @@ -1,5 +1,5 @@ Windows 7 and Windows Server 2008 ---------------------------------- +================================= .. note:: While ownCloud will run in any standard PHP environment, including IIS or Apache on Windows, there are known issues. diff --git a/admin_manual/installation/configuration_yaws.rst b/admin_manual/installation/yaws_configuration.rst similarity index 100% rename from admin_manual/installation/configuration_yaws.rst rename to admin_manual/installation/yaws_configuration.rst diff --git a/admin_manual/issues/index.rst b/admin_manual/issues/index.rst index 78abc66..4f1fdce 100644 --- a/admin_manual/issues/index.rst +++ b/admin_manual/issues/index.rst @@ -1,19 +1,37 @@ -=========== +====== Issues -=========== +====== + +If you have trouble installing, configuring or maintaining ownCloud, please refer to our community support channels: + +* `The ownCloud Forums`_ + +.. note:: The ownCloud forums have a `FAQ page`_ where each topic corresponds to + typical mistakes or frequently occurring issues + +* `The ownCloud User mailing list`_ +* The ownCloud IRC chat channel ``irc://#owncl...@freenode.net`` on freenode.net, also + accessible via `webchat`_ + +Please understand that all these channels essentially consist of users like you helping each other out. Consider helping others out where you can, to contribute back for the help you get. This is the only way to keep a community like ownCloud healthy and sustainable! + +If you are using ownCloud in a business or otherwise large scale deployment, note that ownCloud Inc. offers the `Enterprise Edition`_ with commercial support options. + +Bugs +---- If you think you have found a bug in ownCloud, please: -* Search for a solution +* Search for a solution (see the options above) * Double check your configuration -If you can't find a solution, please file an issue: +If you can't find a solution, please use our `bugtracker`_. -* If the issue is with the ownCloud server, report it to the `GitHub core repository <https://github.com/owncloud/core>`_ -* If the issue is with the ownCloud client, report it to the `GitHub mirall repository <https://github.com/owncloud/mirall>`_ -* If the issue with with an ownCloud app, report it to where that app is developed - * If the app is listed `here <https://github.com/owncloud>`_ report it to the correct repository - * If the app is listed `in the apps repository <https://github.com/owncloud/apps>`_ report it there -Please note that the mailing list should not be used for bug reports, as it is hard to track them there. +.. _the ownCloud Forums: http://forum.owncloud.org +.. _FAQ page: https://forum.owncloud.org/viewforum.php?f=17 +.. _the ownCloud User mailing list: https://mailman.owncloud.org/mailman/listinfo/user +.. _webchat: http://webchat.freenode.net/?channels=owncloud +.. _Enterprise Edition: https://owncloud.com/lp/community-or-enterprise/ +.. _bugtracker: http://doc.owncloud.org/server/7.0/developer_manual/bugtracker/index.html diff --git a/admin_manual/maintenance/convert_db.rst b/admin_manual/maintenance/convert_db.rst index c53c610..2903336 100644 --- a/admin_manual/maintenance/convert_db.rst +++ b/admin_manual/maintenance/convert_db.rst @@ -15,6 +15,12 @@ In ownCloud root folder call php occ db:convert-type [options] type username hostname database +Available values for the ``type`` parameter are: + +* mysql (for MySQL or MariaDB) +* oci (for Oracle) +* pgsql (for PostgreSQL) + The Options * ``--port="3306"`` the database port (optional) diff --git a/admin_manual/maintenance/index.rst b/admin_manual/maintenance/index.rst index ed2827e..f408e18 100644 --- a/admin_manual/maintenance/index.rst +++ b/admin_manual/maintenance/index.rst @@ -3,7 +3,7 @@ Maintenance =========== .. toctree:: - :maxdepth: 1 + :maxdepth: 2 enable_maintenance backup diff --git a/admin_manual/maintenance/upgrade.rst b/admin_manual/maintenance/upgrade.rst index 6ca4431..c27330e 100644 --- a/admin_manual/maintenance/upgrade.rst +++ b/admin_manual/maintenance/upgrade.rst @@ -49,7 +49,7 @@ current ownCloud tarball with ``wget``: ``wget http://download.owncloud.org/community/owncloud-latest.tar.bz2`` For Windows operating systems. see the installation instruction in -:doc:`../installation/installation_windows`. +:doc:`../installation/windows_installation`. 5. Stop your web server. diff --git a/debian/changelog b/debian/changelog index 1212c03..c5a48c2 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,3 +1,56 @@ +owncloud-doc (0~20141208-2) unstable; urgency=medium + + * Upload to unstable in sync with owncloud 7.0.4+dfsg-2 + + -- David Prévot <taf...@debian.org> Wed, 10 Dec 2014 12:14:02 -0400 + +owncloud-doc (0~20141208-1) experimental; urgency=medium + + [ Carla Schroder ] + * Small fixes to filesweb + * moved note re shared folder to a different section + + -- David Prévot <taf...@debian.org> Mon, 08 Dec 2014 16:09:04 -0400 + +owncloud-doc (0~20141205-1) experimental; urgency=medium + + * Upload to experimental in sync with owncloud 7.0.4~rc2+dfsg-1 + + [ Carla Schroder ] + * Added notation about streaming video support + * Update filesweb.rst + * added SELinux howto + * fix missing page links in TOC + + [ Morris Jobke ] + * update documentation generated from config.sample.php + + -- David Prévot <taf...@debian.org> Sun, 07 Dec 2014 15:31:28 -0400 + +owncloud-doc (0~20141201-2) unstable; urgency=medium + + * Upload to unstable in sync with owncloud 7.0.4~rc1+dfsg-2 + + -- David Prévot <taf...@debian.org> Sun, 07 Dec 2014 11:52:51 -0400 + +owncloud-doc (0~20141201-1) experimental; urgency=medium + + * Upload to experimental in sync with owncloud 7.0.4~rc1+dfsg-1 + + [ Jos Poortvliet ] + * improve the description of 3rd party app handling, hopefully dealing with + lots of confusion about that. + + [ Carla Schroder ] + * reorganize and clean up CE admin manual + * remove index.rst, replace with contents.rst + * added note that encryption increases file size + + [ Morris Jobke ] + * update documentation generated from config.sample.php + + -- David Prévot <taf...@debian.org> Mon, 01 Dec 2014 17:47:13 -0400 + owncloud-doc (0~20141107-1) unstable; urgency=medium [ leron49 ] diff --git a/developer_manual/android_library/index.rst b/developer_manual/android_library/index.rst index 8c9a40e..8209321 100644 diff --git a/developer_manual/app/controllers.rst b/developer_manual/app/controllers.rst index 5098f7b..da07754 100644 diff --git a/developer_manual/app/index.rst b/developer_manual/app/index.rst index 1891190..74cb7a4 100644 diff --git a/developer_manual/app/routes.rst b/developer_manual/app/routes.rst index f8de1fd..5cf8a2e 100644 diff --git a/developer_manual/bugtracker/codereviews.rst b/developer_manual/bugtracker/codereviews.rst index 4eae5a3..4d6d9fc 100644 diff --git a/developer_manual/bugtracker/index.rst b/developer_manual/bugtracker/index.rst index 98ea525..611634b 100644 diff --git a/developer_manual/bugtracker/triaging.rst b/developer_manual/bugtracker/triaging.rst new file mode 100644 index 0000000..a6e073c diff --git a/developer_manual/commun/index.rst b/developer_manual/commun/index.rst index ee564fb..ee08342 100644 diff --git a/developer_manual/conf.py b/developer_manual/conf.py index 65c0fe9..407d985 100644 diff --git a/developer_manual/contents.rst b/developer_manual/contents.rst deleted file mode 100644 index 372a656..0000000 diff --git a/developer_manual/core/index.rst b/developer_manual/core/index.rst index 8a59ad1..147c476 100644 diff --git a/developer_manual/general/codingguidelines.rst b/developer_manual/general/codingguidelines.rst index 7b73d9a..7cf9048 100644 diff --git a/developer_manual/general/index.rst b/developer_manual/general/index.rst index 0343d06..f7cc212 100644 diff --git a/developer_manual/images/triageworkflow.png b/developer_manual/images/triageworkflow.png new file mode 100644 index 0000000..8ae9a29 Binary files /dev/null and b/developer_manual/images/triageworkflow.png differ diff --git a/developer_manual/index.rst b/developer_manual/index.rst index 917b0ad..de75795 100644 diff --git a/developer_manual/ios_library/examples.rst b/developer_manual/ios_library/examples.rst index 26f921c..76aaf06 100644 diff --git a/developer_manual/ios_library/index.rst b/developer_manual/ios_library/index.rst index 849bfee..814ad69 100644 diff --git a/developer_manual/ios_library/library_installation.rst b/developer_manual/ios_library/library_installation.rst index 7ec5569..03eee3d 100644 diff --git a/developer_manual/testing/index.rst b/developer_manual/testing/index.rst index 9c0d479..40cb713 100644 diff --git a/go.php b/go.php index 85a5f13..2a24d0d 100644 diff --git a/index/index.rst b/index/index.rst index 044ede2..35b5614 100644 diff --git a/user_manual/documents.rst b/user_manual/documents.rst index d5dc8bb..70ae54f 100644 --- a/user_manual/documents.rst +++ b/user_manual/documents.rst @@ -55,7 +55,8 @@ border color of their user picture. If a user is not a local user (e.g accessing the file using public link), they will be shown as guest in the user list, automatically named Guest 1, Guest 2, -and so on. Guests can change their nicknames at any time. +and so on. Guests can change their nicknames at any time by clicking on their +names or thumbnails in the user list. Delete a Document ~~~~~~~~~~~~~~~~~ diff --git a/user_manual/files/filesweb.rst b/user_manual/files/filesweb.rst index 8afd4d6..4dae07d 100644 --- a/user_manual/files/filesweb.rst +++ b/user_manual/files/filesweb.rst @@ -7,9 +7,7 @@ has the option to disable these features, so if any of them are missing on your system ask your server administrator. .. figure:: ../images/users-files.png - - **ownCloud web interface Files app** - + ownCloud version 7 can display thumbnail previews for image files, MP3 covers, and text files, if this enabled by your server administrator. Hover your cursor over a file or folder to expose the controls for the following operations: @@ -36,11 +34,17 @@ Share Trash Delete the selected file or folder, or unshare a shared file or folder. -.. Note:: The Shared folder has been removed from new installations of ownCloud - 7. Shares now appear in the top level of your file tree on your Files page. - If you are upgrading from older ownCloud versions you will still have your - old Shared folder. Your server administrator has the option to change this in - the server's ``config.php`` file with the ``'share_folder' =>`` directive. +Previewing Files +---------------- + +You can display uncompressed text files, OpenDocument files, videos, and image files in +the ownCloud embedded viewers by clicking on the file name. There may be other file types +you can preview if your ownCloud administrator has enabled them. If ownCloud cannot +display a file, it starts a download process and downloads the file to your computer. + +Video streaming by the native ownCloud video player depends on your Web browser and the +video format. If your ownCloud administrator has enabled video streaming, and it doesn't +work in your Web browser, it may be a browser issue. Navigating Inside Your ownCloud ------------------------------- @@ -143,15 +147,6 @@ External Storage Files that you have access to on external storage devices and services such as Dropbox, Google, and Amazon S3. -Previewing Files ----------------- - -You can display uncompressed text files, OpenDocument files, and image -files from the ownCloud server by clicking on the file name. There may be -other file types you can preview if your ownCloud administrator has enabled -them. If ownCloud cannot display a file, it starts a download process and -downloads the file to your computer. - Moving Files ------------ @@ -166,6 +161,14 @@ with a local user, group, or any person online with a public link. Shared files and folders are labeled with the triangular share icon, and the status *Shared* in the file or folder row. + +.. Note:: The Shared folder has been removed from new installations of ownCloud + 7. Shares now appear in the top level of your file tree on your Files page. + If you are upgrading from older ownCloud versions you will still have your + old Shared folder. Your server administrator has the option to change this in + the server's ``config.php`` file with the ``'share_folder' =>`` directive. + + To create a local share with other users or groups on your ownCloud server: 1. Hover your cursor over an item on the Files page
signature.asc
Description: OpenPGP digital signature