3944aa051c
One of the main problems of the Nextcloud module is that it's currently
not possible to alter e.g. database configuration after the initial
setup as it's written by their imperative installer to a file.
After some research[1] it turned out that it's possible to override all values
with an additional config file. The documentation has been
slightly updated to remain up-to-date, but the warnings should
remain there as the imperative configuration is still used and may cause
unwanted side-effects.
Also simplified the postgresql test which uses `ensure{Databases,Users}` to
configure the database.
Fixes #49783
[1] https://github.com/NixOS/nixpkgs/issues/49783#issuecomment-483063922
117 lines
5.1 KiB
XML
117 lines
5.1 KiB
XML
<chapter xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
version="5.0"
|
|
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>.
|
|
</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>).
|
|
</para>
|
|
|
|
<para>
|
|
A very basic configuration may look like this:
|
|
<programlisting>{ pkgs, ... }:
|
|
{
|
|
services.nextcloud = {
|
|
<link linkend="opt-services.nextcloud.enable">enable</link> = true;
|
|
<link linkend="opt-services.nextcloud.hostName">hostName</link> = "nextcloud.tld";
|
|
<link linkend="opt-services.nextcloud.nginx.enable">nginx.enable</link> = true;
|
|
config = {
|
|
<link linkend="opt-services.nextcloud.config.dbtype">dbtype</link> = "pgsql";
|
|
<link linkend="opt-services.nextcloud.config.dbuser">dbuser</link> = "nextcloud";
|
|
<link linkend="opt-services.nextcloud.config.dbhost">dbhost</link> = "/run/postgresql"; # nextcloud will add /.s.PGSQL.5432 by itself
|
|
<link linkend="opt-services.nextcloud.config.dbname">dbname</link> = "nextcloud";
|
|
<link linkend="opt-services.nextcloud.config.adminpassFile">adminpassFile</link> = "/path/to/admin-pass-file";
|
|
<link linkend="opt-services.nextcloud.config.adminuser">adminuser</link> = "root";
|
|
};
|
|
};
|
|
|
|
services.postgresql = {
|
|
<link linkend="opt-services.postgresql.enable">enable</link> = true;
|
|
<link linkend="opt-services.postgresql.ensureDatabases">ensureDatabases</link> = [ "nextcloud" ];
|
|
<link linkend="opt-services.postgresql.ensureUsers">ensureUsers</link> = [
|
|
{ name = "nextcloud";
|
|
ensurePermissions."DATABASE nextcloud" = "ALL PRIVILEGES";
|
|
}
|
|
];
|
|
};
|
|
|
|
# ensure that postgres is running *before* running the setup
|
|
systemd.services."nextcloud-setup" = {
|
|
requires = ["postgresql.service"];
|
|
after = ["postgresql.service"];
|
|
};
|
|
|
|
<link linkend="opt-networking.firewall.allowedTCPPorts">networking.firewall.allowedTCPPorts</link> = [ 80 443 ];
|
|
}</programlisting>
|
|
</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.
|
|
</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>.
|
|
</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>
|
|
|
|
</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).
|
|
</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.
|
|
</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>
|
|
</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>
|
|
</warning>
|
|
</section>
|
|
</chapter>
|