diff options
Diffstat (limited to 'doc/raketasks')
-rw-r--r-- | doc/raketasks/README.md | 12 | ||||
-rw-r--r-- | doc/raketasks/backup_restore.md | 7 | ||||
-rw-r--r-- | doc/raketasks/cleanup.md | 3 | ||||
-rw-r--r-- | doc/raketasks/features.md | 38 | ||||
-rw-r--r-- | doc/raketasks/maintenance.md | 20 | ||||
-rw-r--r-- | doc/raketasks/user_management.md | 17 | ||||
-rw-r--r-- | doc/raketasks/web_hooks.md | 18 |
7 files changed, 72 insertions, 43 deletions
diff --git a/doc/raketasks/README.md b/doc/raketasks/README.md index b1c97c82237..9e2f697bca6 100644 --- a/doc/raketasks/README.md +++ b/doc/raketasks/README.md @@ -1,6 +1,6 @@ -+ [Backup restore](backup_restore.md) -+ [Cleanup](cleanup.md) -+ [Maintenance](maintenance.md) and self-checks -+ [User management](user_management.md) -+ [Web hooks](web_hooks.md) -+ [Import](import.md) of git repositories in bulk +- [Backup restore](backup_restore.md) +- [Cleanup](cleanup.md) +- [Maintenance](maintenance.md) and self-checks +- [User management](user_management.md) +- [Web hooks](web_hooks.md) +- [Import](import.md) of git repositories in bulk diff --git a/doc/raketasks/backup_restore.md b/doc/raketasks/backup_restore.md index f0be2b6a441..5c1594d13d8 100644 --- a/doc/raketasks/backup_restore.md +++ b/doc/raketasks/backup_restore.md @@ -1,8 +1,9 @@ # Backup restore -### Create a backup of the GitLab system +## Create a backup of the GitLab system Creates a backup archive of the database and all repositories. This archive will be saved in backup_path (see `config/gitlab.yml`). + The filename will be `[TIMESTAMP]_gitlab_backup.tar`. This timestamp can be used to restore an specific backup. ``` @@ -38,7 +39,7 @@ Deleting tmp directories...[DONE] Deleting old backups... [SKIPPING] ``` -### Restore a previously created backup +## Restore a previously created backup ``` bundle exec rake gitlab:backup:restore RAILS_ENV=production @@ -81,7 +82,7 @@ Restoring repositories: Deleting tmp directories...[DONE] ``` -### Configure cron to make daily backups +## Configure cron to make daily backups ``` cd /home/git/gitlab diff --git a/doc/raketasks/cleanup.md b/doc/raketasks/cleanup.md index b0b82754da6..4b3b6d71a75 100644 --- a/doc/raketasks/cleanup.md +++ b/doc/raketasks/cleanup.md @@ -1,6 +1,6 @@ # Cleanup -### Remove garbage from filesystem. Important! Data loss! +## Remove garbage from filesystem. Important! Data loss! Remove namespaces(dirs) from `/home/git/repositories` if they don't exist in GitLab database. @@ -13,4 +13,3 @@ Remove repositories (global only for now) from `/home/git/repositories` if they ``` bundle exec rake gitlab:cleanup:repos RAILS_ENV=production ``` - diff --git a/doc/raketasks/features.md b/doc/raketasks/features.md new file mode 100644 index 00000000000..eaa9af5f962 --- /dev/null +++ b/doc/raketasks/features.md @@ -0,0 +1,38 @@ +# Features + +## Enable usernames and namespaces for user projects + +This command will enable the namespaces feature introduced in v4.0. It will move every project in its namespace folder. + +Note: + +- Because the **repository location will change**, you will need to **update all your git url's** to point to the new location. +- Username can be changed at [Profile / Account](/profile/account) + +**Example:** + +Old path: `git@example.org:myrepo.git` + +New path: `git@example.org:username/myrepo.git` or `git@example.org:groupname/myrepo.git` + +``` +bundle exec rake gitlab:enable_namespaces RAILS_ENV=production +``` + +## Rebuild project satellites + +This command will build missing satellites for projects. After this you will be able to **merge a merge request** via GitLab and use the **online editor**. + +``` +bundle exec rake gitlab:satellites:create RAILS_ENV=production +``` + +Example output: + +``` +Creating satellite for abcd.git +[git clone output] +Creating satellite for abcd2.git +[git clone output] +done +``` diff --git a/doc/raketasks/maintenance.md b/doc/raketasks/maintenance.md index e9ae3fb300e..30276dd7629 100644 --- a/doc/raketasks/maintenance.md +++ b/doc/raketasks/maintenance.md @@ -1,9 +1,8 @@ # Maintenance -### Gather information about GitLab and the system it runs on +## Gather information about GitLab and the system it runs on -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. +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. ``` bundle exec rake gitlab:env:info RAILS_ENV=production @@ -39,15 +38,14 @@ Hooks: /home/git/gitlab-shell/hooks/ Git: /usr/bin/git ``` - -### Check GitLab configuration +## Check GitLab configuration Runs the following rake tasks: -* gitlab:env:check -* gitlab:gitlab_shell:check -* gitlab:sidekiq:check -* gitlab:app:check +- `gitlab:env:check` +- `gitlab:gitlab_shell:check` +- `gitlab:sidekiq:check` +- `gitlab:app:check` It will check that each component was setup according to the installation guide and suggest fixes for issues found. @@ -103,10 +101,10 @@ Redis version >= 2.0.0? ... yes Checking GitLab ... Finished ``` - -### (Re-)Create satellite repos +## (Re-)Create satellite repos This will create satellite repos for all your projects. + If necessary, remove the `tmp/repo_satellites` directory and rerun the command below. ``` diff --git a/doc/raketasks/user_management.md b/doc/raketasks/user_management.md index d5b173fde65..81378494c6b 100644 --- a/doc/raketasks/user_management.md +++ b/doc/raketasks/user_management.md @@ -1,34 +1,33 @@ # User management -### Add user as a developer to all projects +## Add user as a developer to all projects ```bash bundle exec rake gitlab:import:user_to_projects[username@domain.tld] ``` - -### Add all users to all projects +## Add all users to all projects Notes: -* admin users are added as masters +- admin users are added as masters ```bash bundle exec rake gitlab:import:all_users_to_all_projects ``` -### Add user as a developer to all groups +## Add user as a developer to all groups -``` +```bash bundle exec rake gitlab:import:user_to_groups[username@domain.tld] ``` -### Add all users to all groups +## Add all users to all groups Notes: -* admin users are added as owners so they can add additional users to the group +- admin users are added as owners so they can add additional users to the group -``` +```bash bundle exec rake gitlab:import:all_users_to_all_groups ``` diff --git a/doc/raketasks/web_hooks.md b/doc/raketasks/web_hooks.md index 4ffbf5f8698..704473af2d9 100644 --- a/doc/raketasks/web_hooks.md +++ b/doc/raketasks/web_hooks.md @@ -1,33 +1,27 @@ # Web hooks -### Add a web hook for **ALL** projects: +## Add a web hook for **ALL** projects: RAILS_ENV=production bundle exec rake gitlab:web_hook:add URL="http://example.com/hook" - -### Add a web hook for projects in a given **NAMESPACE**: +## Add a web hook for projects in a given **NAMESPACE**: RAILS_ENV=production bundle exec rake gitlab:web_hook:add URL="http://example.com/hook" NAMESPACE=acme - -### Remove a web hook from **ALL** projects using: +## Remove a web hook from **ALL** projects using: RAILS_ENV=production bundle exec rake gitlab:web_hook:rm URL="http://example.com/hook" - -### Remove a web hook from projects in a given **NAMESPACE**: +## Remove a web hook from projects in a given **NAMESPACE**: RAILS_ENV=production bundle exec rake gitlab:web_hook:rm URL="http://example.com/hook" NAMESPACE=acme - -### List **ALL** web hooks: +## List **ALL** web hooks: RAILS_ENV=production bundle exec rake gitlab:web_hook:list - -### List the web hooks from projects in a given **NAMESPACE**: +## List the web hooks from projects in a given **NAMESPACE**: RAILS_ENV=production bundle exec rake gitlab:web_hook:list NAMESPACE=/ > Note: `/` is the global namespace. - |