Commit 8be2fbf97e7a30768036cf1342334216868e56f5
1 parent
b52bb468
Exists in
master
and in
13 other branches
Group the configuartion changes under one header.
Showing
1 changed file
with
10 additions
and
7 deletions
Show diff stats
README.md
| @@ -36,9 +36,7 @@ You can login as an admin user with username `root` and password `5iveL!fe`. | @@ -36,9 +36,7 @@ You can login as an admin user with username `root` and password `5iveL!fe`. | ||
| 36 | 36 | ||
| 37 | For update instructions, see [the update guide](doc/update.md). | 37 | For update instructions, see [the update guide](doc/update.md). |
| 38 | 38 | ||
| 39 | -## How to manage an Omnibus-installed GitLab | ||
| 40 | - | ||
| 41 | -### Start/stop GitLab | 39 | +## Starting and stopping |
| 42 | 40 | ||
| 43 | You can start, stop or restart GitLab and all of its components with the | 41 | You can start, stop or restart GitLab and all of its components with the |
| 44 | following commands. | 42 | following commands. |
| @@ -60,6 +58,8 @@ It is also possible to start, stop or restart individual components. | @@ -60,6 +58,8 @@ It is also possible to start, stop or restart individual components. | ||
| 60 | sudo gitlab-ctl restart unicorn | 58 | sudo gitlab-ctl restart unicorn |
| 61 | ``` | 59 | ``` |
| 62 | 60 | ||
| 61 | +## Configuration | ||
| 62 | + | ||
| 63 | ### Creating the gitlab.rb configuration file | 63 | ### Creating the gitlab.rb configuration file |
| 64 | 64 | ||
| 65 | ```shell | 65 | ```shell |
| @@ -68,7 +68,8 @@ sudo touch /etc/gitlab/gitlab.rb | @@ -68,7 +68,8 @@ sudo touch /etc/gitlab/gitlab.rb | ||
| 68 | sudo chmod 600 /etc/gitlab/gitlab.rb | 68 | sudo chmod 600 /etc/gitlab/gitlab.rb |
| 69 | ``` | 69 | ``` |
| 70 | 70 | ||
| 71 | -Below several examples are given to change settings in `/etc/gitlab/gitlab.rb`. | 71 | +Below several examples are given for settings in `/etc/gitlab/gitlab.rb`. |
| 72 | +Please restart each time you made a change. | ||
| 72 | 73 | ||
| 73 | ### Configuring the external URL for GitLab | 74 | ### Configuring the external URL for GitLab |
| 74 | 75 | ||
| @@ -157,6 +158,8 @@ sudo lokkit -p 2443:tcp | @@ -157,6 +158,8 @@ sudo lokkit -p 2443:tcp | ||
| 157 | 158 | ||
| 158 | Run `sudo gitlab-ctl reconfigure` for the change to take effect. | 159 | Run `sudo gitlab-ctl reconfigure` for the change to take effect. |
| 159 | 160 | ||
| 161 | +## Backups | ||
| 162 | + | ||
| 160 | ### Creating an application backup | 163 | ### Creating an application backup |
| 161 | 164 | ||
| 162 | To create a backup of your repositories and GitLab metadata, run the following command. | 165 | To create a backup of your repositories and GitLab metadata, run the following command. |
| @@ -215,7 +218,7 @@ If there is a GitLab version mismatch between your backup tar file and the insta | @@ -215,7 +218,7 @@ If there is a GitLab version mismatch between your backup tar file and the insta | ||
| 215 | version of GitLab, the restore command will abort with an error. Install a package for | 218 | version of GitLab, the restore command will abort with an error. Install a package for |
| 216 | the [required version](https://www.gitlab.com/downloads/archives/) and try again. | 219 | the [required version](https://www.gitlab.com/downloads/archives/) and try again. |
| 217 | 220 | ||
| 218 | -### Invoking Rake tasks | 221 | +## Invoking Rake tasks |
| 219 | 222 | ||
| 220 | To invoke a GitLab Rake task, use `gitlab-rake`. For example: | 223 | To invoke a GitLab Rake task, use `gitlab-rake`. For example: |
| 221 | 224 | ||
| @@ -227,7 +230,7 @@ Contrary to with a traditional GitLab installation, there is no need to change | @@ -227,7 +230,7 @@ Contrary to with a traditional GitLab installation, there is no need to change | ||
| 227 | the user or the `RAILS_ENV` environment variable; this is taken care of by the | 230 | the user or the `RAILS_ENV` environment variable; this is taken care of by the |
| 228 | `gitlab-rake` wrapper script. | 231 | `gitlab-rake` wrapper script. |
| 229 | 232 | ||
| 230 | -### Directory structure | 233 | +## Directory structure |
| 231 | 234 | ||
| 232 | Omnibus-gitlab uses four different directories. | 235 | Omnibus-gitlab uses four different directories. |
| 233 | 236 | ||
| @@ -239,7 +242,7 @@ Omnibus-gitlab uses four different directories. | @@ -239,7 +242,7 @@ Omnibus-gitlab uses four different directories. | ||
| 239 | - `/var/log/gitlab` contains all log data generated by components of | 242 | - `/var/log/gitlab` contains all log data generated by components of |
| 240 | omnibus-gitlab. | 243 | omnibus-gitlab. |
| 241 | 244 | ||
| 242 | -### Starting a Rails console session | 245 | +## Starting a Rails console session |
| 243 | 246 | ||
| 244 | For advanced users only. If you need access to a Rails production console for your | 247 | For advanced users only. If you need access to a Rails production console for your |
| 245 | GitLab installation you can start one with the following command: | 248 | GitLab installation you can start one with the following command: |