[Pkg-owncloud-commits] [owncloud-doc] 08/38: generate documentation from config.sample.php

Fri Oct 24 14:11:58 UTC 2014

This is an automated email from the git hooks/post-receive script.

taffit pushed a commit to branch master
in repository owncloud-doc.

commit 12f2b5cb249a48003b7af788bcdcc7de4535dfbe
Author: Morris Jobke <hey at morrisjobke.de>
Date:   Fri Oct 17 00:58:31 2014 +0200

    generate documentation from config.sample.php
---
 .../configuration_config_sample_php.rst            | 46 +++++++++++++++++++---
 1 file changed, 40 insertions(+), 6 deletions(-)

diff --git a/admin_manual/configuration/configuration_config_sample_php.rst b/admin_manual/configuration/configuration_config_sample_php.rst
index fb53a5f..d5df1ec 100644
--- a/admin_manual/configuration/configuration_config_sample_php.rst
+++ b/admin_manual/configuration/configuration_config_sample_php.rst
@@ -9,6 +9,7 @@ configurable on your Admin page, so it is usually not necessary to edit
 .. Generated content below. Don't change this.
 .. DEFAULT_SECTION_START
 
+
 Default Parameters
 ------------------
 
@@ -21,7 +22,11 @@ for your ownCloud server to operate.
 	'instanceid' => '',
 
 This is a unique identifier for your ownCloud installation, created
-automatically by the installer. Do not change it.
+automatically by the installer. This example is for documentation only,
+and you should never use it because it will not work. A valid ``instanceid``
+is created when you install ownCloud.
+
+'instanceid' => 'd3c944a9a',
 
 ::
 
@@ -29,11 +34,18 @@ automatically by the installer. Do not change it.
 
 The salt used to hash all passwords, auto-generated by the ownCloud
 installer. (There are also per-user salts.) If you lose this salt you lose
-all your passwords.
+all your passwords. This example is for documentation only,
+and you should never use it.
+
+'passwordsalt' => 'd3c944a9af095aa08f',
 
 ::
 
-	'trusted_domains' => array('demo.example.org', 'otherdomain.example.org:8080'),
+	'trusted_domains' =>
+	  array (
+	    'demo.example.org',
+	    'otherdomain.example.org:8080',
+	  ),
 
 Your list of trusted domains that users can log into. Specifying trusted
 domains prevents host header poisoning. Do not remove this, as it performs
@@ -41,7 +53,7 @@ necessary security checks.
 
 ::
 
-	'datadirectory' => '',
+	'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.
@@ -159,6 +171,7 @@ This example is from a new ownCloud installation using MariaDB::
 .. Generated content below. Don't change this.
 .. ALL_OTHER_SECTIONS_START
 
+
 User Experience
 ---------------
 
@@ -251,6 +264,7 @@ skeleton files.
 The ``user_backends`` app allows you to configure alternate authentication
 backends. Supported backends are IMAP (OC_User_IMAP), SMB (OC_User_SMB), and
 FTP (OC_User_FTP).
+
 Mail Parameters
 ---------------
 
@@ -355,6 +369,7 @@ the SMTP server.
 
 This depends on ``mail_smtpauth``. Specify the password for authenticating to
 the SMTP server.
+
 Proxy Configurations
 --------------------
 
@@ -421,6 +436,7 @@ The URL of your proxy server, for example ``proxy.example.com:8081``.
 The optional authentication for the proxy to use to connect to the internet.
 
 The format is: ``username:password``.
+
 Deleted Items (trash bin)
 -------------------------
 
@@ -440,6 +456,7 @@ will be kept in the trash bin. Default is 30 days.
 
 Disable or enable auto-expiration for the trash bin. By default
 auto-expiration is enabled.
+
 ownCloud Verifications
 ----------------------
 
@@ -484,6 +501,7 @@ to ``true``. This verifies that the ``.htaccess`` file is writable and works.
 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.
+
 Logging
 -------
 
@@ -544,6 +562,7 @@ or no rotation. Specify a size in bytes, for example 104857600 (100 megabytes
 = 100 * 1024 * 1024 bytes). A new logfile is created with a new name when the
 old logfile reaches your limit. The total size of all logfiles is double the
 ``log_rotate_sizerotation`` value.
+
 Alternate Code Locations
 ------------------------
 
@@ -577,6 +596,7 @@ seen by a Web browser.
 
 This section is for configuring the download links for ownCloud clients, as
 seen in the first-run wizard and on Personal pages.
+
 Apps
 ----
 
@@ -621,6 +641,8 @@ public API. If the app uses the private API it cannot be installed.
 
 
 
+
+
 Previews
 --------
 
@@ -633,7 +655,14 @@ size.
 
 	'enable_previews' => true,
 
-TODO
+By default, ownCloud can generate previews for the following filetypes:
+
+- Images files
+- Covers of MP3 files
+- Text documents
+
+Valid values are ``true``, to enable previews, or
+``false``, to disable previews
 
 ::
 
@@ -701,6 +730,7 @@ concerns:
  - OC\Preview\PDF
  - OC\Preview\StarOffice
  - OC\Preview\SVG
+
 Maintenance
 -----------
 
@@ -725,6 +755,7 @@ of ownCloud instantly.
 
 When set to ``true``, the ownCloud instance will be unavailable for all users
 who are not in the ``admin`` group.
+
 SSL
 ---
 
@@ -743,6 +774,7 @@ HTTP requests.
 	),
 
 Extra SSL options to be used for configuration.
+
 Miscellaneous
 -------------
 
@@ -751,7 +783,9 @@ Miscellaneous
 
 	'blacklisted_files' => array('.htaccess'),
 
-Blacklist a specific file and disallow the upload of files with this name
+Blacklist a specific file or files and disallow the upload of files
+with this name. ``.htaccess`` is blocked by default.
+
 WARNING: USE THIS ONLY IF YOU KNOW WHAT YOU ARE DOING.
 
 ::

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-owncloud/owncloud-doc.git

