summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axil@gitlab.com>2018-07-02 07:41:07 +0000
committerAchilleas Pipinellis <axil@gitlab.com>2018-07-02 07:41:07 +0000
commit765c4d9459c274beccf5d24396d3427b517dfa11 (patch)
tree57f8869bf4db7c8376878ec5db6dc9af31c0e9ed
parent3cf683629e62fa4810512b20f4f54140591829ef (diff)
parent739c69cccb918a8f995df6ed088c586d9b6f60c1 (diff)
downloadgitlab-ce-765c4d9459c274beccf5d24396d3427b517dfa11.tar.gz
Merge branch 'sh-improve-backup-directory-docs' into 'master'
Document that DIRECTORY environment variable in backups only applies to remote storage Closes #38949 See merge request gitlab-org/gitlab-ce!20230
-rw-r--r--doc/raketasks/backup_restore.md19
1 files changed, 10 insertions, 9 deletions
diff --git a/doc/raketasks/backup_restore.md b/doc/raketasks/backup_restore.md
index 95221d8b6b1..2e7702dda07 100644
--- a/doc/raketasks/backup_restore.md
+++ b/doc/raketasks/backup_restore.md
@@ -326,6 +326,16 @@ For installations from source:
1. [Restart GitLab] for the changes to take effect
+#### Specifying a custom directory for backups
+
+Note: This option only works for remote storage. If you want to group your backups
+you can pass a `DIRECTORY` environment variable:
+
+```
+sudo gitlab-rake gitlab:backup:create DIRECTORY=daily
+sudo gitlab-rake gitlab:backup:create DIRECTORY=weekly
+```
+
### Uploading to locally mounted shares
You may also send backups to a mounted share (`NFS` / `CIFS` / `SMB` / etc.) by
@@ -369,15 +379,6 @@ For installations from source:
remote_directory: 'gitlab_backups'
```
-### Specifying a custom directory for backups
-
-If you want to group your backups you can pass a `DIRECTORY` environment variable:
-
-```
-sudo gitlab-rake gitlab:backup:create DIRECTORY=daily
-sudo gitlab-rake gitlab:backup:create DIRECTORY=weekly
-```
-
### Backup archive permissions
The backup archives created by GitLab (`1393513186_2014_02_27_gitlab_backup.tar`)