aboutsummaryrefslogtreecommitdiff
path: root/nixos/modules/services/web-apps/nextcloud.xml
diff options
context:
space:
mode:
authorEelco Dolstra <edolstra@gmail.com>2019-09-19 19:17:30 +0200
committerEelco Dolstra <edolstra@gmail.com>2019-09-19 19:17:30 +0200
commitb0ccd6dd16909c8639c2d9bee7dd2a2a0ac74c30 (patch)
treeee6367837650bb97dc5117d518217b11294900fe /nixos/modules/services/web-apps/nextcloud.xml
parentdb3d31b903da12bc471e91d811d231dfe5b662ef (diff)
Revert "nixos/doc: re-format"
This reverts commit ea6e8775bd69e4676c623a85c39f1da540d29ad1. The new format is not an improvement.
Diffstat (limited to '')
-rw-r--r--nixos/modules/services/web-apps/nextcloud.xml55
1 files changed, 41 insertions, 14 deletions
diff --git a/nixos/modules/services/web-apps/nextcloud.xml b/nixos/modules/services/web-apps/nextcloud.xml
index 4345c2b9810..d66e0f0c299 100644
--- a/nixos/modules/services/web-apps/nextcloud.xml
+++ b/nixos/modules/services/web-apps/nextcloud.xml
@@ -5,13 +5,21 @@
xml:id="module-services-nextcloud">
<title>Nextcloud</title>
<para>
- <link xlink:href="https://nextcloud.com/">Nextcloud</link> is an open-source, self-hostable cloud platform. The server setup can be automated using <link linkend="opt-services.nextcloud.enable">services.nextcloud</link>. A desktop client is packaged at <literal>pkgs.nextcloud-client</literal>.
+ <link xlink:href="https://nextcloud.com/">Nextcloud</link> is an open-source,
+ self-hostable cloud platform. The server setup can be automated using
+ <link linkend="opt-services.nextcloud.enable">services.nextcloud</link>. A
+ desktop client is packaged at <literal>pkgs.nextcloud-client</literal>.
</para>
<section xml:id="module-services-nextcloud-basic-usage">
<title>Basic usage</title>
<para>
- Nextcloud is a PHP-based application which requires an HTTP server (<literal><link linkend="opt-services.nextcloud.enable">services.nextcloud</link></literal> optionally supports <literal><link linkend="opt-services.nginx.enable">services.nginx</link></literal>) and a database (it's recommended to use <literal><link linkend="opt-services.postgresql.enable">services.postgresql</link></literal>).
+ Nextcloud is a PHP-based application which requires an HTTP server
+ (<literal><link linkend="opt-services.nextcloud.enable">services.nextcloud</link></literal>
+ optionally supports
+ <literal><link linkend="opt-services.nginx.enable">services.nginx</link></literal>)
+ and a database (it's recommended to use
+ <literal><link linkend="opt-services.postgresql.enable">services.postgresql</link></literal>).
</para>
<para>
@@ -53,38 +61,57 @@
</para>
<para>
- The options <literal>hostName</literal> and <literal>nginx.enable</literal> are used internally to configure an HTTP server using <literal><link xlink:href="https://php-fpm.org/">PHP-FPM</link></literal> and <literal>nginx</literal>. The <literal>config</literal> attribute set is used by the imperative installer and all values are written to an additional file to ensure that changes can be applied by changing the module's options.
+ The options <literal>hostName</literal> and <literal>nginx.enable</literal>
+ are used internally to configure an HTTP server using
+ <literal><link xlink:href="https://php-fpm.org/">PHP-FPM</link></literal>
+ and <literal>nginx</literal>. The <literal>config</literal> attribute set is
+ used by the imperative installer and all values are written to an additional file
+ to ensure that changes can be applied by changing the module's options.
</para>
<para>
- In case the application serves multiple domains (those are checked with <literal><link xlink:href="http://php.net/manual/en/reserved.variables.server.php">$_SERVER['HTTP_HOST']</link></literal>) it's needed to add them to <literal><link linkend="opt-services.nextcloud.config.extraTrustedDomains">services.nextcloud.config.extraTrustedDomains</link></literal>.
+ In case the application serves multiple domains (those are checked with
+ <literal><link xlink:href="http://php.net/manual/en/reserved.variables.server.php">$_SERVER['HTTP_HOST']</link></literal>)
+ it's needed to add them to
+ <literal><link linkend="opt-services.nextcloud.config.extraTrustedDomains">services.nextcloud.config.extraTrustedDomains</link></literal>.
</para>
<para>
- Auto updates for Nextcloud apps can be enabled using <literal><link linkend="opt-services.nextcloud.autoUpdateApps.enable">services.nextcloud.autoUpdateApps</link></literal>.
- </para>
+ Auto updates for Nextcloud apps can be enabled using
+ <literal><link linkend="opt-services.nextcloud.autoUpdateApps.enable">services.nextcloud.autoUpdateApps</link></literal>.
+</para>
+
</section>
<section xml:id="module-services-nextcloud-pitfalls-during-upgrade">
<title>Pitfalls</title>
<para>
- Unfortunately Nextcloud appears to be very stateful when it comes to managing its own configuration. The config file lives in the home directory of the <literal>nextcloud</literal> user (by default <literal>/var/lib/nextcloud/config/config.php</literal>) and is also used to track several states of the application (e.g. whether installed or not).
+ Unfortunately Nextcloud appears to be very stateful when it comes to
+ managing its own configuration. The config file lives in the home directory
+ of the <literal>nextcloud</literal> user (by default
+ <literal>/var/lib/nextcloud/config/config.php</literal>) and is also used to
+ track several states of the application (e.g. whether installed or not).
</para>
<para>
- All configuration parameters are also stored in <literal>/var/lib/nextcloud/config/override.config.php</literal> which is generated by the module and linked from the store to ensure that all values from <literal>config.php</literal> can be modified by the module. However <literal>config.php</literal> manages the application's state and shouldn't be touched manually because of that.
+ All configuration parameters are also stored in
+ <literal>/var/lib/nextcloud/config/override.config.php</literal> which is generated by
+ the module and linked from the store to ensure that all values from <literal>config.php</literal>
+ can be modified by the module.
+ However <literal>config.php</literal> manages the application's state and shouldn't be touched
+ manually because of that.
</para>
<warning>
- <para>
- Don't delete <literal>config.php</literal>! This file tracks the application's state and a deletion can cause unwanted side-effects!
- </para>
+ <para>Don't delete <literal>config.php</literal>! This file
+ tracks the application's state and a deletion can cause unwanted
+ side-effects!</para>
</warning>
<warning>
- <para>
- Don't rerun <literal>nextcloud-occ maintenance:install</literal>! This command tries to install the application and can cause unwanted side-effects!
- </para>
+ <para>Don't rerun <literal>nextcloud-occ
+ maintenance:install</literal>! This command tries to install the application
+ and can cause unwanted side-effects!</para>
</warning>
</section>
</chapter>