summaryrefslogtreecommitdiff
path: root/doc/raketasks
diff options
context:
space:
mode:
authorJacob Vosmaer <contact@jacobvosmaer.nl>2014-06-23 10:38:22 +0200
committerJacob Vosmaer <contact@jacobvosmaer.nl>2014-06-23 10:38:22 +0200
commitffece96dd13fc99e24d65f2a374572c218c1f892 (patch)
tree5c965cd879f5472f515e6657d5618a3c6bd0d319 /doc/raketasks
parent73c1030da1318284495288461210e8d145aa7181 (diff)
downloadgitlab-ce-ffece96dd13fc99e24d65f2a374572c218c1f892.tar.gz
Spell out rake tasks for omnibus-gitlab
Diffstat (limited to 'doc/raketasks')
-rw-r--r--doc/raketasks/backup_restore.md10
-rw-r--r--doc/raketasks/cleanup.md8
-rw-r--r--doc/raketasks/import.md4
-rw-r--r--doc/raketasks/maintenance.md8
-rw-r--r--doc/raketasks/user_management.md16
5 files changed, 46 insertions, 0 deletions
diff --git a/doc/raketasks/backup_restore.md b/doc/raketasks/backup_restore.md
index 5c1594d13d8..00ce6ed27c2 100644
--- a/doc/raketasks/backup_restore.md
+++ b/doc/raketasks/backup_restore.md
@@ -7,6 +7,10 @@ Creates a backup archive of the database and all repositories. This archive will
The filename will be `[TIMESTAMP]_gitlab_backup.tar`. This timestamp can be used to restore an specific backup.
```
+# omnibus-gitlab
+sudo gitlab-rake gitlab:backup:create
+
+# installation from source or cookbook
bundle exec rake gitlab:backup:create RAILS_ENV=production
```
@@ -42,6 +46,10 @@ Deleting old backups... [SKIPPING]
## Restore a previously created backup
```
+# omnibus-gitlab
+sudo gitlab-rake gitlab:backup:restore
+
+# installation from source or cookbook
bundle exec rake gitlab:backup:restore RAILS_ENV=production
```
@@ -84,6 +92,8 @@ Deleting tmp directories...[DONE]
## Configure cron to make daily backups
+For omnibus-gitlab, see https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/README.md#scheduling-a-backup .
+
```
cd /home/git/gitlab
sudo -u git -H editor config/gitlab.yml # Enable keep_time in the backup section to automatically delete old backups
diff --git a/doc/raketasks/cleanup.md b/doc/raketasks/cleanup.md
index 4b3b6d71a75..9e48f56c951 100644
--- a/doc/raketasks/cleanup.md
+++ b/doc/raketasks/cleanup.md
@@ -5,11 +5,19 @@
Remove namespaces(dirs) from `/home/git/repositories` if they don't exist in GitLab database.
```
+# omnibus-gitlab
+sudo gitlab-rake gitlab:cleanup:dirs
+
+# installation from source or cookbook
bundle exec rake gitlab:cleanup:dirs RAILS_ENV=production
```
Remove repositories (global only for now) from `/home/git/repositories` if they don't exist in GitLab database.
```
+# omnibus-gitlab
+sudo gitlab-rake gitlab:cleanup:repos
+
+# installation from source or cookbook
bundle exec rake gitlab:cleanup:repos RAILS_ENV=production
```
diff --git a/doc/raketasks/import.md b/doc/raketasks/import.md
index 628bd373b8d..39b1a52a44d 100644
--- a/doc/raketasks/import.md
+++ b/doc/raketasks/import.md
@@ -15,6 +15,10 @@ How to use:
2. run the command below
```
+# omnibus-gitlab
+sudo gitlab-rake gitlab:import:repos
+
+# installation from source or cookbook
bundle exec rake gitlab:import:repos RAILS_ENV=production
```
diff --git a/doc/raketasks/maintenance.md b/doc/raketasks/maintenance.md
index 30276dd7629..3339dfb03ac 100644
--- a/doc/raketasks/maintenance.md
+++ b/doc/raketasks/maintenance.md
@@ -5,6 +5,10 @@
This command gathers information about your GitLab installation and the System it runs on. These may be useful when asking for help or reporting issues.
```
+# omnibus-gitlab
+sudo gitlab-rake gitlab:env:info
+
+# installation from source or cookbook
bundle exec rake gitlab:env:info RAILS_ENV=production
```
@@ -52,6 +56,10 @@ It will check that each component was setup according to the installation guide
You may also have a look at our [Trouble Shooting Guide](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Trouble-Shooting-Guide).
```
+# omnibus-gitlab
+sudo gitlab-rake gitlab:check
+
+# installation from source or cookbook
bundle exec rake gitlab:check RAILS_ENV=production
```
diff --git a/doc/raketasks/user_management.md b/doc/raketasks/user_management.md
index 81378494c6b..eb9eebb4b4a 100644
--- a/doc/raketasks/user_management.md
+++ b/doc/raketasks/user_management.md
@@ -3,6 +3,10 @@
## Add user as a developer to all projects
```bash
+# omnibus-gitlab
+sudo gitlab-rake gitlab:import:user_to_projects[username@domain.tld]
+
+# installation from source or cookbook
bundle exec rake gitlab:import:user_to_projects[username@domain.tld]
```
@@ -13,12 +17,20 @@ Notes:
- admin users are added as masters
```bash
+# omnibus-gitlab
+sudo gitlab-rake gitlab:import:all_users_to_all_projects
+
+# installation from source or cookbook
bundle exec rake gitlab:import:all_users_to_all_projects
```
## Add user as a developer to all groups
```bash
+# omnibus-gitlab
+sudo gitlab-rake gitlab:import:user_to_groups[username@domain.tld]
+
+# installation from source or cookbook
bundle exec rake gitlab:import:user_to_groups[username@domain.tld]
```
@@ -29,5 +41,9 @@ Notes:
- admin users are added as owners so they can add additional users to the group
```bash
+# omnibus-gitlab
+sudo gitlab-rake gitlab:import:all_users_to_all_groups
+
+# installation from source or cookbook
bundle exec rake gitlab:import:all_users_to_all_groups
```