nixos/gitlab: Document automatic backups

talyz abba76a3 7b5cbde8

Changed files
+37 -10
nixos
doc
manual
release-notes
modules
services
misc
+8
nixos/doc/manual/release-notes/rl-2105.xml
···
Please test your setup and container images with containerd prior to upgrading.
</para>
</listitem>
</itemizedlist>
</section>
</section>
···
Please test your setup and container images with containerd prior to upgrading.
</para>
</listitem>
+
<listitem>
+
<para>
+
The GitLab module now has support for automatic backups. A
+
schedule can be set with the
+
<link linkend="opt-services.gitlab.backup.startAt">services.gitlab.backup.startAt</link>
+
option.
+
</para>
+
</listitem>
</itemizedlist>
</section>
</section>
+29 -10
nixos/modules/services/misc/gitlab.xml
···
<section xml:id="module-services-gitlab-maintenance">
<title>Maintenance</title>
-
<para>
-
You can run GitLab's rake tasks with <literal>gitlab-rake</literal> which
-
will be available on the system when gitlab is enabled. You will have to run
-
the command as the user that you configured to run gitlab with.
-
</para>
-
<para>
-
For example, to backup a GitLab instance:
<screen>
-
<prompt>$ </prompt>sudo -u git -H gitlab-rake gitlab:backup:create
</screen>
-
A list of all availabe rake tasks can be obtained by running:
<screen>
<prompt>$ </prompt>sudo -u git -H gitlab-rake -T
</screen>
-
</para>
</section>
</chapter>
···
<section xml:id="module-services-gitlab-maintenance">
<title>Maintenance</title>
+
<section xml:id="module-services-gitlab-maintenance-backups">
+
<title>Backups</title>
+
<para>
+
Backups can be configured with the options in <link
+
linkend="opt-services.gitlab.backup.keepTime">services.gitlab.backup</link>. Use
+
the <link
+
linkend="opt-services.gitlab.backup.startAt">services.gitlab.backup.startAt</link>
+
option to configure regular backups.
+
</para>
+
<para>
+
To run a manual backup, start the <literal>gitlab-backup</literal> service:
<screen>
+
<prompt>$ </prompt>systemctl start gitlab-backup.service
</screen>
+
</para>
+
</section>
+
+
<section xml:id="module-services-gitlab-maintenance-rake">
+
<title>Rake tasks</title>
+
+
<para>
+
You can run GitLab's rake tasks with <literal>gitlab-rake</literal>
+
which will be available on the system when GitLab is enabled. You
+
will have to run the command as the user that you configured to run
+
GitLab with.
+
</para>
+
+
<para>
+
A list of all availabe rake tasks can be obtained by running:
<screen>
<prompt>$ </prompt>sudo -u git -H gitlab-rake -T
</screen>
+
</para>
+
</section>
</section>
</chapter>