Merge pull request #651 from owncloud/alphabeta

reorganize and clean up CE admin manual
This commit is contained in:
Carla Schroder
2014-11-17 19:33:31 -08:00
46 changed files with 150 additions and 131 deletions

View File

@@ -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`.

View File

@@ -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**

View File

@@ -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

View File

@@ -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

View File

@@ -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.

View File

@@ -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

View File

@@ -5,30 +5,30 @@ Configuration
.. toctree::
:maxdepth: 1
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
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_side_encryption_configuration
server_to_server_configuration
serving_static_files_configuration
thirdparty_php_configuration
user_auth_ftp_smb_imap
user_auth_ldap
user_configuration

View File

@@ -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.

View File

@@ -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.

View File

@@ -1,5 +1,5 @@
Using Server-Side Encryption
============================
Server-Side 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

View File

@@ -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).

View File

@@ -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.

View File

@@ -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

View File

@@ -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:`server_side_encryption_configuration`.
Renaming a User
~~~~~~~~~~~~~~~

View File

@@ -17,8 +17,3 @@ ownCloud documentation contents
configuration/index
maintenance/index
issues/index
Indices and tables
==================
* :ref:`genindex`

View File

@@ -25,58 +25,66 @@ 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`
* :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`
.. 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.
.. 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/server_side_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 +93,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`

View File

@@ -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

View File

@@ -5,15 +5,16 @@ Installation
.. toctree::
:maxdepth: 1
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
lighttpd_configuration
linux_installation
macos_installation
nginx_configuration
others_installation
source_installation
ucs_installation
windows_installation
yaws_configuration

View File

@@ -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.

View File

@@ -6,7 +6,7 @@ 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

View File

@@ -344,8 +344,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 +398,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`

View File

@@ -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.

View File

@@ -1,6 +1,6 @@
===========
======
Issues
===========
======
If you think you have found a bug in ownCloud, please:

View File

@@ -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.