Skip to content

Commit

Permalink
generate documentation from config.sample.php
Browse files Browse the repository at this point in the history
  • Loading branch information
MorrisJobke committed Aug 20, 2018
1 parent afc66eb commit 94e49c3
Showing 1 changed file with 48 additions and 21 deletions.
69 changes: 48 additions & 21 deletions admin_manual/configuration_server/config_sample_php_parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,31 @@ code.

Defaults to ``false``

::

'default_locale' => 'en_US',

This sets the default locale on your Nextcloud server, using ISO_639
language codes such as ``en`` for English, ``de`` for German, and ``fr`` for
French, and ISO-3166 country codes such as ``GB``, ``US``, ``CA``, as defined
in RFC 5646. It overrides automatic locale detection on public pages like
login or shared items. User's locale preferences configured under "personal
-> locale" override this setting after they have logged in.

Defaults to ``en``

::

'force_locale' => 'en_US',

With this setting a locale can be forced for all users. If a locale is
forced, the users are also unable to change their locale in the personal
settings. If users shall be unable to change their locale, but users have
different languages, this value can be set to ``true`` instead of a locale
code.

Defaults to ``false``

::

'defaultapp' => 'files',
Expand Down Expand Up @@ -389,24 +414,19 @@ Defaults to ``false``

::

'mail_smtpmode' => 'php',
'mail_smtpmode' => 'smtp',

Which mode to use for sending mail: ``sendmail``, ``smtp``, ``qmail`` or
``php``.
Which mode to use for sending mail: ``sendmail``, ``smtp`` or ``qmail``.

If you are using local or remote SMTP, set this to ``smtp``.

If you are using PHP mail you must have an installed and working email system
on the server. The program used to send email is defined in the ``php.ini``
file.

For the ``sendmail`` option you need an installed and working email system on
the server, with ``/usr/sbin/sendmail`` installed on your Unix system.

For ``qmail`` the binary is /var/qmail/bin/sendmail, and it must be installed
on your Unix system.

Defaults to ``php``
Defaults to ``smtp``

::

Expand Down Expand Up @@ -810,20 +830,26 @@ Logging

'log_type' => 'file',

By default the Nextcloud logs are sent to the ``nextcloud.log`` file in the
default Nextcloud data directory.
This parameter determines where the Nextcloud logs are sent.

If syslogging is desired, set this parameter to ``syslog``.
Setting this parameter to ``errorlog`` will use the PHP error_log function
for logging.
``file``: the logs are written to file ``nextcloud.log`` in the default
Nextcloud data directory. The log file can be changed with parameter
``logfile``.
``syslog``: the logs are sent to the system log. This requires a syslog daemon
to be active.
``errorlog``: the logs are sent to the PHP ``error_log`` function.
``systemd``: the logs are sent to the Systemd journal. This requires a system
that runs Systemd and the Systemd journal. The PHP extension ``systemd``
must be installed and active.

Defaults to ``file``

::

'logfile' => '/var/log/nextcloud.log',

Log file path for the Nextcloud logging type.
Name of the file to which the Nextcloud logs are written if parameter
``log_type`` is set to ``file``.

Defaults to ``[datadirectory]/nextcloud.log``

Expand All @@ -842,7 +868,8 @@ Defaults to ``2``

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``.
with a unique id. Only available if ``log_type`` is set to ``syslog`` or
``systemd``.

The default value is ``Nextcloud``.

Expand Down Expand Up @@ -925,11 +952,11 @@ Some of the Nextcloud code may be stored in alternate locations.
This section is for configuring the download links for Nextcloud clients, as
seen in the first-run wizard and on Personal pages.

Defaults to:
- Desktop client: ``https://nextcloud.com/install/#install-clients``
- Android client: ``https://play.google.com/store/apps/details?id=com.nextcloud.client``
- iOS client: ``https://itunes.apple.com/us/app/nextcloud/id1125420102?mt=8``
- iOS client app id: ``1125420102``
Defaults to
* Desktop client: ``https://nextcloud.com/install/#install-clients``
* Android client: ``https://play.google.com/store/apps/details?id=com.nextcloud.client``
* iOS client: ``https://itunes.apple.com/us/app/nextcloud/id1125420102?mt=8``
*iOS client app id: ``1125420102``
Apps
----
Expand Down Expand Up @@ -1039,7 +1066,7 @@ Defaults to ``''`` (empty string)

'preview_office_cl_parameters' =>
' --headless --nologo --nofirststartwizard --invisible --norestore '.
'--convert-to pdf --outdir ',
'--convert-to png --outdir ',

Use this if LibreOffice/OpenOffice requires additional arguments.

Expand Down

0 comments on commit 94e49c3

Please sign in to comment.