Commit 242417c60964331a19ae89e40e534f87ab4625b0
1 parent
e1c7d63e
Exists in
master
and in
17 other branches
Add documentation for the external_url option
Showing
1 changed file
with
44 additions
and
10 deletions
Show diff stats
README.md
@@ -32,26 +32,60 @@ sudo lokkit -s http -s ssh | @@ -32,26 +32,60 @@ sudo lokkit -s http -s ssh | ||
32 | 32 | ||
33 | ### Administrative commands | 33 | ### Administrative commands |
34 | 34 | ||
35 | -You can make configuration changes by editing `/etc/gitlab/gitlab.rb` and | ||
36 | -`/etc/gitlab/gitlab-secrets.json`, followed by running | 35 | +#### Start/stop GitLab |
37 | 36 | ||
37 | +You can start, stop or restart GitLab and all of its components with the | ||
38 | +following commands. | ||
39 | + | ||
40 | +```shell | ||
41 | +# Start all GitLab components | ||
42 | +sudo gitlab-ctl start | ||
43 | + | ||
44 | +# Stop all GitLab components | ||
45 | +sudo gitlab-ctl stop | ||
46 | + | ||
47 | +# Restart all GitLab components | ||
48 | +sudo gitlab-ctl restart | ||
38 | ``` | 49 | ``` |
39 | -sudo gitlab-ctl reconfigure | 50 | + |
51 | +It is also possible to start, stop or restart individual components. | ||
52 | + | ||
53 | +```shell | ||
54 | +sudo gitlab-ctl restart unicorn | ||
55 | +``` | ||
56 | + | ||
57 | +#### Creating the gitlab.rb configuration file | ||
58 | + | ||
59 | +```shell | ||
60 | +sudo mkdir -p /etc/gitlab | ||
61 | +sudo touch /etc/gitlab/gitlab.rb | ||
62 | +sudo chmod 600 /etc/gitlab/gitlab.rb | ||
40 | ``` | 63 | ``` |
41 | 64 | ||
42 | -To start/stop a component of GitLab run e.g. | ||
43 | -`sudo gitlab-ctl stop sidekiq`. To permanently disable e.g. Sidekiq, add | ||
44 | -`sidekiq['enable'] = false` to `/etc/gitlab/gitlab.rb`, and run | ||
45 | -`sudo gitlab-ctl reconfigure` for the change to take effect. | 65 | +#### Configuring the external URL for GitLab |
46 | 66 | ||
47 | -To invoke a GitLab rake task, use `gitlab-rake`. For example: | 67 | +In order for GitLab to display correct repository clone links to your users |
68 | +it needs to know the URL under which it is reached by your users, e.g. | ||
69 | +`http://gitlab.example.com`. Add the following line to `/etc/gitlab/gitlab.rb`: | ||
48 | 70 | ||
71 | +```ruby | ||
72 | +external_url "http://gitlab.example.com" | ||
49 | ``` | 73 | ``` |
74 | + | ||
75 | +Run `sudo gitlab-ctl reconfigure` for the change to take effect. | ||
76 | + | ||
77 | + | ||
78 | +#### Invoking Rake tasks | ||
79 | + | ||
80 | +To invoke a GitLab Rake task, use `gitlab-rake`. For example: | ||
81 | + | ||
82 | +```shell | ||
50 | sudo gitlab-rake gitlab:backup:create | 83 | sudo gitlab-rake gitlab:backup:create |
51 | ``` | 84 | ``` |
52 | 85 | ||
53 | -There is no need to change the user or the `RAILS_ENV` environment variable; | ||
54 | -this is taken care of by the `gitlab-rake` wrapper script. | 86 | +Contrary to with a traditional GitLab installation, there is no need to change |
87 | +the user or the `RAILS_ENV` environment variable; this is taken care of by the | ||
88 | +`gitlab-rake` wrapper script. | ||
55 | 89 | ||
56 | ### Directory structure | 90 | ### Directory structure |
57 | 91 |