Download as
Browse Code »

Commit 26e1026896eb8fd1905447fbf4b9a249f8ef2ac1

Authored by Sytse Sijbrandij
2 parents 8ccc5e8a fb998346
Exists in master and in 17 other branches 6-6-stable, 6-6-stable-ee, 6-7-stable, 6-7-stable-ee, 6-8-stable, 6-8-stable-ee, 6-9-stable, 6-9-stable-ee, 7-0-stable, 7-0-stable-ee, 7-0-stable-spb, 7-1-stable, 7-1-stable-ee, 7-2-stable, 7-2-stable-ee, branch_test, nginx_ssl_tweaks

Merge branch 'minimal_docs' into 'master' 

Minimal Docs
Showing 1 changed file with 37 additions and 0 deletions   Show diff stats
README.md
  Diff comments   View file @26e1026
... ... @@ -3,6 +3,43 @@
3 3 This project creates full-stack platform-specific packages for
4 4 GitLab!
5 5  
  6 +## How to manage an Omnibus-installed GitLab
  7 +
  8 +### Administrative commands
  9 +
  10 +You can make configuration changes by editing `/etc/gitlab/gitlab.rb` and
  11 +`/etc/gitlab/gitlab-secrets.json`, followed by running
  12 +
  13 +```
  14 +sudo gitlab-ctl reconfigure
  15 +```
  16 +
  17 +To start/stop a component of GitLab run e.g.
  18 +`sudo gitlab-ctl stop sidekiq`. To permanently disable e.g. Sidekiq, add
  19 +`sidekiq['enable'] = false` to `/etc/gitlab/gitlab.rb`, and run
  20 +`sudo gitlab-ctl reconfigure` for the change to take effect.
  21 +
  22 +To invoke a GitLab rake task, use `gitlab-rake`. For example:
  23 +
  24 +```
  25 +sudo gitlab-rake gitlab:backup:create
  26 +```
  27 +
  28 +There is no need to change the user or the `RAILS_ENV` environment variable;
  29 +this is taken care of by the `gitlab-rake` wrapper script.
  30 +
  31 +### Directory structure
  32 +
  33 +Omnibus-gitlab uses four different directories.
  34 +
  35 +- `/opt/gitlab` holds application code for GitLab and its dependencies.
  36 +- `/var/opt/gitlab` holds application data and configuration files that
  37 + `gitlab-ctl reconfigure` writes too.
  38 +- `/etc/gitlab` holds configuration files for omnibus-gitlab. These are
  39 + the only files that you should ever have to edit manually.
  40 +- `/var/log/gitlab` contains all log data generated by components of
  41 + omnibus-gitlab.
  42 +
6 43 ## Preparing a build environment on Ubuntu 12.04
7 44  
8 45 To create builds you will need a build user (`ubuntu:ubuntu` in our example).
... ...