mirrors/nextcloud-documentation
3
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2025-10-26 11:18:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

generate documentation from config.sample.php

Browse Source
This commit is contained in:
Morris Jobke 2016-06-27 03:35:12 +02:00
parent e917b2ab52
commit 4a5317dc0e
1 changed files with 101 additions and 139 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

240
admin_manual/configuration_server/config_sample_php_parameters.rst
View File

@ -30,18 +30,18 @@ Nextcloud, and the values in these files take precedence over :file:`config.php`
Default Parameters
------------------
These parameters are configured by the ownCloud installer, and are required
for your ownCloud server to operate.
These parameters are configured by the Nextcloud installer, and are required
for your Nextcloud server to operate.
::
'instanceid' => '',
This is a unique identifier for your ownCloud installation, created
This is a unique identifier for your Nextcloud installation, created
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.
is created when you install Nextcloud.
'instanceid' => 'd3c944a9a',
@ -49,7 +49,7 @@ is created when you install ownCloud.
'passwordsalt' => '',
The salt used to hash all passwords, auto-generated by the ownCloud
The salt used to hash all passwords, auto-generated by the Nextcloud
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.
@ -68,18 +68,16 @@ necessary security checks.
::
'datadirectory' => '/var/www/owncloud/data',
'datadirectory' => '/var/www/nextcloud/data',
Where user files are stored; this defaults to ``data/`` in the ownCloud
Where user files are stored; this defaults to ``data/`` in the Nextcloud
directory. The SQLite database is also stored here, when you use SQLite.
(SQLite is not available in ownCloud Enterprise Edition)
::
'version' => '',
The current version number of your ownCloud installation. This is set up
The current version number of your Nextcloud installation. This is set up
during installation and update, so you shouldn't need to change it.
::
@ -90,10 +88,10 @@ Identifies the database used with this installation. See also config option
``supportedDatabases``
Available:
- sqlite (SQLite3 - Not in Enterprise Edition)
- sqlite (SQLite3)
- mysql (MySQL/MariaDB)
- pgsql (PostgreSQL)
- oci (Oracle - Enterprise Edition Only)
- oci (Oracle)
::
@ -106,17 +104,17 @@ Your host server name, for example ``localhost``, ``hostname``,
::
'dbname' => 'owncloud',
'dbname' => 'nextcloud',
The name of the ownCloud database, which is set during installation. You
The name of the Nextcloud database, which is set during installation. You
should not need to change this.
::
'dbuser' => '',
The user that ownCloud uses to write to the database. This must be unique
across ownCloud instances using the same SQL database. This is set up during
The user that Nextcloud uses to write to the database. This must be unique
across Nextcloud instances using the same SQL database. This is set up during
installation, so you shouldn't need to change it.
::
@ -130,13 +128,13 @@ you shouldn't need to change it.
'dbtableprefix' => '',
Prefix for the ownCloud tables in the database.
Prefix for the Nextcloud tables in the database.
::
'installed' => false,
Indicates whether the ownCloud instance was installed successfully; ``true``
Indicates whether the Nextcloud instance was installed successfully; ``true``
indicates a successful installation, and ``false`` indicates an unsuccessful
installation.
@ -207,7 +205,7 @@ values, where present, are shown.
'default_language' => 'en',
This sets the default language on your ownCloud server, using ISO_639-1
This sets the default language on your Nextcloud server, using ISO_639-1
language codes such as ``en`` for English, ``de`` for German, and ``fr`` for
French. It overrides automatic language detection on public pages like login
or shared items. User's language preferences configured under "personal ->
@ -220,7 +218,7 @@ language" override this setting after they have logged in.
Set the default app to open on login. Use the app names as they appear in the
URL after clicking them in the Apps menu, such as documents, calendar, and
gallery. You can use a comma-separated list of app names, so if the first
app is not enabled for a user then ownCloud will try the second one, and so
app is not enabled for a user then Nextcloud will try the second one, and so
on. If no enabled apps are found it defaults to the Files app.
::
@ -228,7 +226,7 @@ on. If no enabled apps are found it defaults to the Files app.
'knowledgebaseenabled' => true,
``true`` enables the Help menu item in the user menu (top right of the
ownCloud Web interface). ``false`` removes the Help item.
Nextcloud Web interface). ``false`` removes the Help item.
::
@ -270,7 +268,7 @@ Enabling this sends a "heartbeat" to the server to keep it from timing out.
::
'skeletondirectory' => '/path/to/owncloud/core/skeleton',
'skeletondirectory' => '/path/to/nextcloud/core/skeleton',
The directory where the skeleton files are located. These files will be
copied to the data directory of new users. Leave empty to not copy any
@ -301,7 +299,7 @@ login-attempt.
Mail Parameters
---------------
These configure the email settings for ownCloud notifications and password
These configure the email settings for Nextcloud notifications and password
resets.
@ -309,13 +307,13 @@ resets.
'mail_domain' => 'example.com',
The return address that you want to appear on emails sent by the ownCloud
server, for example ``oc-admin@example.com``, substituting your own domain,
The return address that you want to appear on emails sent by the Nextcloud
server, for example ``nc-admin@example.com``, substituting your own domain,
of course.
::
'mail_from_address' => 'owncloud',
'mail_from_address' => 'nextcloud',
FROM address that overrides the built-in ``sharing-noreply`` and
``lostpassword-noreply`` FROM addresses.
@ -411,7 +409,7 @@ Proxy Configurations
'overwritehost' => '',
The automatic hostname detection of ownCloud can fail in certain reverse
The automatic hostname detection of Nextcloud can fail in certain reverse
proxy and CLI/cron situations. This option allows you to manually override
the automatic detection; for example ``www.example.com``, or specify the port
``www.example.com:8080``.
@ -420,9 +418,9 @@ the automatic detection; for example ``www.example.com``, or specify the port
'overwriteprotocol' => '',
When generating URLs, ownCloud attempts to detect whether the server is
accessed via ``https`` or ``http``. However, if ownCloud is behind a proxy
and the proxy handles the ``https`` calls, ownCloud would not know that
When generating URLs, Nextcloud attempts to detect whether the server is
accessed via ``https`` or ``http``. However, if Nextcloud is behind a proxy
and the proxy handles the ``https`` calls, Nextcloud would not know that
``ssl`` is in use, which would result in incorrect URLs being generated.
Valid values are ``http`` and ``https``.
@ -431,12 +429,12 @@ Valid values are ``http`` and ``https``.
'overwritewebroot' => '',
ownCloud attempts to detect the webroot for generating URLs automatically.
Nextcloud attempts to detect the webroot for generating URLs automatically.
For example, if ``www.example.com/owncloud`` is the URL pointing to the
ownCloud instance, the webroot is ``/owncloud``. When proxies are in use, it
may be difficult for ownCloud to detect this parameter, resulting in invalid
URLs.
For example, if ``www.example.com/nextcloud`` is the URL pointing to the
Nextcloud instance, the webroot is ``/nextcloud``. When proxies are in use,
it may be difficult for Nextcloud to detect this parameter, resulting in
invalid URLs.
::
@ -452,9 +450,9 @@ addresses starting with ``10.0.0.`` and ending with 1 to 3:
'overwrite.cli.url' => '',
Use this configuration parameter to specify the base URL for any URLs which
are generated within ownCloud using any kind of command line tools (cron or
are generated within Nextcloud using any kind of command line tools (cron or
occ). The value should contain the full base URL:
``https://www.example.com/owncloud``
``https://www.example.com/nextcloud``
::
@ -463,13 +461,13 @@ occ). The value should contain the full base URL:
To have clean URLs without `/index.php` this parameter needs to be configured.
This parameter will be written as "RewriteBase" on update and installation of
ownCloud to your `.htaccess` file. While this value is often simply the URL
path of the ownCloud installation it cannot be set automatically properly in
Nextcloud to your `.htaccess` file. While this value is often simply the URL
path of the Nextcloud installation it cannot be set automatically properly in
every scenario and needs thus some manual configuration.
In a standard Apache setup this usually equals the folder that ownCloud is
accessible at. So if ownCloud is accessible via "https://mycloud.org/owncloud"
the correct value would most likely be "/owncloud". If ownCloud is running
In a standard Apache setup this usually equals the folder that Nextcloud is
accessible at. So if Nextcloud is accessible via "https://mycloud.org/nextcloud"
the correct value would most likely be "/nextcloud". If Nextcloud is running
under "https://mycloud.org/" then it would be "/".
Note that above rule is not valid in every case, there are some rare setup
@ -477,7 +475,7 @@ cases where this may not apply. However, to avoid any update problems this
configuration value is explicitly opt-in.
After setting this value run `occ maintenance:update:htaccess` and when following
conditions are met ownCloud uses URLs without index.php in it:
conditions are met Nextcloud uses URLs without index.php in it:
- `mod_rewrite` is installed
- `mod_env` is installed
@ -564,8 +562,8 @@ Available values:
* ``auto``
default setting. Automatically expire versions according to expire
rules. Please refer to Files_versions online documentation for more
info.
rules. Please refer to :doc:`../configuration_files/file_versioning` for
more information.
* ``D, auto``
keep versions at least for D days, apply expire rules to all versions
that are older than D days
@ -577,10 +575,10 @@ Available values:
* ``disabled``
versions auto clean disabled, versions will be kept forever
ownCloud Verifications
----------------------
Nextcloud Verifications
-----------------------
ownCloud performs several verification checks. There are two options,
Nextcloud performs several verification checks. There are two options,
``true`` and ``false``.
@ -596,7 +594,7 @@ enable apps that pass this check.
'updatechecker' => true,
Check if ownCloud is up-to-date and shows a notification if a new version is
Check if Nextcloud is up-to-date and shows a notification if a new version is
available.
::
@ -609,20 +607,20 @@ URL that Nextcloud should use to look for updates
'has_internet_connection' => true,
Is ownCloud connected to the Internet or running in a closed network?
Is Nextcloud connected to the Internet or running in a closed network?
::
'check_for_working_webdav' => true,
Allows ownCloud to verify a working WebDAV connection. This is done by
Allows Nextcloud to verify a working WebDAV connection. This is done by
attempting to make a WebDAV request from PHP.
::
'check_for_working_wellknown_setup' => true,
Allows ownCloud to verify a working .well-known URL redirects. This is done
Allows Nextcloud to verify a working .well-known URL redirects. This is done
by attempting to make a request from JS to
https://your-domain.com/.well-known/caldav/
@ -643,9 +641,9 @@ which verifies that it can't be accessed directly through the Web server.
In certain environments it is desired to have a read-only configuration file.
When this switch is set to ``true`` ownCloud will not verify whether the
When this switch is set to ``true`` Nextcloud 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
all options via the Web interface. Furthermore, when updating Nextcloud
it is required to make the configuration file writable again for the update
process.
@ -657,8 +655,8 @@ Logging
'log_type' => 'owncloud',
By default the ownCloud logs are sent to the ``owncloud.log`` file in the
default ownCloud data directory.
By default the Nextcloud logs are sent to the ``owncloud.log`` file in the
default Nextcloud data directory.
If syslogging is desired, set this parameter to ``syslog``.
Setting this parameter to ``errorlog`` will use the PHP error_log function
@ -668,7 +666,7 @@ for logging.
'logfile' => '/var/log/owncloud.log',
Log file path for the ownCloud logging type.
Log file path for the Nextcloud logging type.
Defaults to ``[datadirectory]/owncloud.log``
@ -681,13 +679,13 @@ Warning, 3 = Error, and 4 = Fatal. The default value is Warning.
::
'syslog_tag' => 'ownCloud',
'syslog_tag' => 'Nextcloud',
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``.
The default value is ``Nextcloud``.
::
@ -737,19 +735,6 @@ debugging, as your logfile will become huge.
Log successful cron runs.
::
'cron.lockfile.location' => '',
Location of the lock file for cron executions can be specified here.
Default is within the tmp directory. The file is named in the following way:
owncloud-server-$INSTANCEID-cron.lock
where $INSTANCEID is the string specified in the ``instanceid`` field.
Because the cron lock file is accessed at regular intervals, it may prevent
enabled disk drives from spinning down. A different location for this file
can solve such issues.
::
'log_rotate_size' => false,
@ -760,40 +745,16 @@ or no rotation. Specify a size in bytes, for example 104857600 (100 megabytes
old logfile reaches your limit. If a rotated log file is already present, it
will be overwritten.
Alternate Code Locations
------------------------
Some of the ownCloud code may be stored in alternate locations.
::
'3rdpartyroot' => '',
ownCloud uses some 3rd party PHP components to provide certain functionality.
These components are shipped as part of the software package and reside in
``owncloud/3rdparty``. Use this option to configure a different location.
For example, if your location is /var/www/owncloud/foo/3rdparty, then the
correct configuration is '3rdpartyroot' => '/var/www/owncloud/foo/',
::
'3rdpartyurl' => '',
If you have an alternate ``3rdpartyroot``, you must also configure the URL as
seen by a Web browser.
::
'customclient_desktop' =>
'http://owncloud.org/sync-clients/',
'https://nextcloud.com/install/',
'customclient_android' =>
'https://play.google.com/store/apps/details?id=com.owncloud.android',
'https://play.google.com/store/apps/details?id=com.nextcloud.client',
'customclient_ios' =>
'https://itunes.apple.com/us/app/owncloud/id543672169?mt=8',
This section is for configuring the download links for ownCloud clients, as
This section is for configuring the download links for Nextcloud clients, as
seen in the first-run wizard and on Personal pages.
Apps
@ -806,7 +767,7 @@ Options for the Apps folder, Apps store, and App code checker.
'appstoreenabled' => true,
When enabled, admins may install apps from the ownCloud app store.
When enabled, admins may install apps from the Nextcloud app store.
::
@ -828,7 +789,7 @@ loss or security breaches.
'apps_paths' => array(
array(
'path'=> '/var/www/owncloud/apps',
'path'=> '/var/www/nextcloud/apps',
'url' => '/apps',
'writable' => true,
),
@ -838,7 +799,7 @@ Use the ``apps_paths`` parameter to set the location of the Apps directory,
which should be scanned for available apps, and where user-specific apps
should be installed from the Apps store. The ``path`` defines the absolute
file system path to the app folder. The key ``url`` defines the HTTP Web path
to that folder, starting from the ownCloud webroot. The key ``writable``
to that folder, starting from the Nextcloud webroot. The key ``writable``
indicates if a Web server can write files to that folder.
::
@ -856,7 +817,7 @@ enable apps that pass this check.
Previews
--------
ownCloud supports previews of image files, the covers of MP3 files, and text
Nextcloud supports previews of image files, the covers of MP3 files, and text
files. These options control enabling and disabling previews, and thumbnail
size.
@ -865,7 +826,7 @@ size.
'enable_previews' => true,
By default, ownCloud can generate previews for the following filetypes:
By default, Nextcloud can generate previews for the following filetypes:
- Image files
- Covers of MP3 files
@ -892,7 +853,7 @@ is no limit.
'preview_max_scale_factor' => 10,
If a lot of small pictures are stored on the ownCloud instance and the
If a lot of small pictures are stored on the Nextcloud instance and the
preview system generates blurry previews, you might want to consider setting
a maximum scale factor. By default, pictures are upscaled to 10 times the
original size. A value of ``1`` or ``null`` disables scaling.
@ -919,7 +880,7 @@ custom path for LibreOffice/OpenOffice binary
'preview_office_cl_parameters' =>
' --headless --nologo --nofirststartwizard --invisible --norestore '.
'-convert-to pdf -outdir ',
'--convert-to pdf --outdir ',
Use this if LibreOffice/OpenOffice requires additional arguments.
@ -1028,19 +989,19 @@ maintenance.
'maintenance' => false,
Enable maintenance mode to disable ownCloud
Enable maintenance mode to disable Nextcloud
If you want to prevent users from logging in to ownCloud before you start
If you want to prevent users from logging in to Nextcloud before you start
doing some maintenance work, you need to set the value of the maintenance
parameter to true. Please keep in mind that users who are already logged-in
are kicked out of ownCloud instantly.
are kicked out of Nextcloud instantly.
::
'singleuser' => false,
When set to ``true``, the ownCloud instance will be unavailable for all users
who are not in the ``admin`` group.
When set to ``true``, the Nextcloud instance will be unavailable for all
users who are not in the ``admin`` group.
SSL
---
@ -1134,8 +1095,8 @@ Location of the cache folder, defaults to ``data/$user/cache`` where
``$cache_path/$user`` where ``$cache_path`` is the configured cache directory
and ``$user`` is the user.
Using Object Store with ownCloud
--------------------------------
Using Object Store with Nextcloud
---------------------------------
::
@ -1149,7 +1110,7 @@ Using Object Store with ownCloud
// generate a password
'password' => 'Secr3tPaSSWoRdt7',
// must already exist in the objectstore, name can be different
'container' => 'owncloud',
'container' => 'nextcloud',
// create the container if it does not exist. default is false
'autocreate' => true,
// required, dev-/trystack defaults to 'RegionOne'
@ -1166,10 +1127,10 @@ Using Object Store with ownCloud
),
),
This example shows how to configure ownCloud to store all files in a
This example shows how to configure Nextcloud to store all files in a
swift object storage.
It is important to note that ownCloud in object store mode will expect
It is important to note that Nextcloud in object store mode will expect
exclusive access to the object store container because it only stores the
binary data for each file. The metadata is currently kept in the local
database for performance reasons.
@ -1204,10 +1165,11 @@ All other configuration options
'dbdriveroptions' => array(
PDO::MYSQL_ATTR_SSL_CA => '/file/path/to/ca_cert.pem',
PDO::MYSQL_ATTR_INIT_COMMAND => 'SET wait_timeout = 28800'
),
Additional driver options for the database connection, eg. to enable SSL
encryption in MySQL.
encryption in MySQL or specify a custom wait timeout on a cheap hoster.
::
@ -1228,16 +1190,16 @@ can be 'WAL' or 'DELETE' see for more details https://www.sqlite.org/wal.html
Database types that are supported for installation.
Available:
- sqlite (SQLite3 - Not in Enterprise Edition)
- sqlite (SQLite3)
- mysql (MySQL)
- pgsql (PostgreSQL)
- oci (Oracle - Enterprise Edition Only)
- oci (Oracle)
::
'tempdirectory' => '/tmp/owncloudtemp',
'tempdirectory' => '/tmp/nextcloudtemp',
Override where ownCloud stores temporary files. Useful in situations where
Override where Nextcloud 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.
@ -1248,7 +1210,7 @@ The Web server user must have write access to this directory.
'hashingCost' => 10,
The hashing cost used by hashes generated by ownCloud
The hashing cost used by hashes generated by Nextcloud
Using a higher value requires more time and CPU power to calculate the hashes
::
@ -1270,9 +1232,9 @@ Define a default folder for shared files and folders other than root.
'theme' => '',
If you are applying a theme to ownCloud, enter the name of the theme here.
If you are applying a theme to Nextcloud, enter the name of the theme here.
The default location for themes is ``owncloud/themes/``.
The default location for themes is ``nextcloud/themes/``.
::
@ -1287,8 +1249,8 @@ AES-256-CFB are supported.
The minimum ownCloud desktop client version that will be allowed to sync with
this server instance. All connections made from earlier clients will be denied
by the server. Defaults to the minimum officially supported ownCloud version at
the time of release of this server version.
by the server. Defaults to the minimum officially supported ownCloud desktop
client version at the time of release of this server version.
When changing this, note that older unsupported versions of the ownCloud desktop
client may not function as expected, and could lead to permanent data loss for
@ -1305,8 +1267,8 @@ calculation, defaults to false.
'filesystem_check_changes' => 0,
Specifies how often the local filesystem (the ownCloud data/ directory, and
NFS mounts in data/) is checked for changes made outside ownCloud. This
Specifies how often the local filesystem (the Nextcloud data/ directory, and
NFS mounts in data/) is checked for changes made outside Nextcloud. This
does not apply to external storages.
0 -> Never check the filesystem for outside changes, provides a performance
@ -1320,7 +1282,7 @@ general use if outside changes might happen.
'part_file_in_storage' => true,
On default ownCloud will store the part files created during upload in the
By default Nextcloud will store the part files created during upload in the
same storage as the upload target. Setting this to false will store the part
files in the root of the users folder which might be required to work with certain
external storage setups that have limited rename capabilities.
@ -1334,35 +1296,35 @@ file and one css file if this is set to ``true``. This improves performance.
::
'assetdirectory' => '/var/www/owncloud',
'assetdirectory' => '/var/www/nextcloud',
The parent of the directory where css and js assets will be stored if
pipelining is enabled; this defaults to the ownCloud directory. The assets
pipelining is enabled; this defaults to the Nextcloud directory. The assets
will be stored in a subdirectory of this directory named 'assets'. The
server *must* be configured to serve that directory as $WEBROOT/assets.
You will only likely need to change this if the main ownCloud directory
You will only likely need to change this if the main Nextcloud directory
is not writeable by the Web server in your configuration.
::
'mount_file' => '/var/www/owncloud/data/mount.json',
'mount_file' => '/var/www/nextcloud/data/mount.json',
Where ``mount.json`` file should be stored, defaults to ``data/mount.json``
in the ownCloud directory.
in the Nextcloud directory.
::
'filesystem_cache_readonly' => false,
When ``true``, prevent ownCloud from changing the cache due to changes in the
filesystem for all storage.
When ``true``, prevent Nextcloud from changing the cache due to changes in
the filesystem for all storage.
::
'secret' => '',
Secret used by ownCloud for various purposes, e.g. to encrypt data. If you
Secret used by Nextcloud for various purposes, e.g. to encrypt data. If you
lose this string there will be data corruption.
::
@ -1383,7 +1345,7 @@ Headers that should be trusted as client IP address in combination with
'HTTP_X_FORWARDED_FOR' here.
If set incorrectly, a client can spoof their IP address as visible to
ownCloud, bypassing access controls and making logs useless!
Nextcloud, bypassing access controls and making logs useless!
Defaults to 'HTTP_X_FORWARED_FOR' if unset
@ -1425,7 +1387,7 @@ is highly recommended to *avoid data loss*.
'debug' => false,
Set this ownCloud instance to debugging mode
Set this Nextcloud 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