public
/
nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

nixos/gitlab: Document automatic backups

This commit is contained in:
talyz 2021-02-25 13:48:33 +01:00
parent 7b5cbde81f
commit abba76a3b9
No known key found for this signature in database
GPG Key ID: 2DED2151F4671A2B
2 changed files with 37 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
nixos/doc/manual/release-notes/rl-2105.xml
View File

@ -883,6 +883,14 @@ environment.systemPackages = [
Please test your setup and container images with containerd prior to upgrading. Please test your setup and container images with containerd prior to upgrading.
</para> </para>
</listitem> </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> </itemizedlist>
</section> </section>
</section> </section>

39
nixos/modules/services/misc/gitlab.xml
View File

@ -112,21 +112,40 @@ services.gitlab = {
<section xml:id="module-services-gitlab-maintenance"> <section xml:id="module-services-gitlab-maintenance">
<title>Maintenance</title> <title>Maintenance</title>
<para> <section xml:id="module-services-gitlab-maintenance-backups">
You can run GitLab's rake tasks with <literal>gitlab-rake</literal> which <title>Backups</title>
will be available on the system when gitlab is enabled. You will have to run <para>
the command as the user that you configured to run gitlab with. Backups can be configured with the options in <link
</para> 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> <para>
For example, to backup a GitLab instance: To run a manual backup, start the <literal>gitlab-backup</literal> service:
<screen> <screen>
<prompt>$ </prompt>sudo -u git -H gitlab-rake gitlab:backup:create <prompt>$ </prompt>systemctl start gitlab-backup.service
</screen> </screen>
A list of all availabe rake tasks can be obtained by running: </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> <screen>
<prompt>$ </prompt>sudo -u git -H gitlab-rake -T <prompt>$ </prompt>sudo -u git -H gitlab-rake -T
</screen> </screen>
</para> </para>
</section>
</section> </section>
</chapter> </chapter>