kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity

Merge branch 'docs-capitalization-3' into 'master'

Browse source 
Update capitalization in /integrations and /raketasks

See merge request gitlab-org/gitlab-ce!32241
This commit is contained in:
Achilleas Pipinellis 2019-08-27 08:41:51 +00:00
commit a200715ff5
35 changed files with 82 additions and 79 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/integration/auth0.md
View file

@ -30,7 +30,7 @@ application.
1. On your GitLab server, open the configuration file.
For omnibus package:
For Omnibus package:
```sh
sudo editor /etc/gitlab/gitlab.rb
@ -48,7 +48,7 @@ application.
1. Add the provider configuration:
For omnibus package:
For Omnibus package:
```ruby
gitlab_rails['omniauth_providers'] = [

4
doc/integration/azure.md
View file

@ -32,7 +32,7 @@ To enable the Microsoft Azure OAuth2 OmniAuth provider you must register your ap
1. On your GitLab server, open the configuration file.
For omnibus package:
For Omnibus package:
```sh
sudo editor /etc/gitlab/gitlab.rb
@ -50,7 +50,7 @@ To enable the Microsoft Azure OAuth2 OmniAuth provider you must register your ap
1. Add the provider configuration:
For omnibus package:
For Omnibus package:
```ruby
gitlab_rails['omniauth_providers'] = [

4
doc/integration/cas.md
View file

@ -4,7 +4,7 @@ To enable the CAS OmniAuth provider you must register your application with your
1. On your GitLab server, open the configuration file.
For omnibus package:
For Omnibus package:
```sh
sudo editor /etc/gitlab/gitlab.rb
@ -22,7 +22,7 @@ To enable the CAS OmniAuth provider you must register your application with your
1. Add the provider configuration:
For omnibus package:
For Omnibus package:
```ruby
gitlab_rails['omniauth_providers'] = [

22
doc/integration/elasticsearch.md
View file

@ -123,8 +123,8 @@ production instances, they recommend considerably more resources.
Storage requirements also vary based on the installation side, but as a rule of
thumb, you should allocate the total size of your production database, **plus**
two-thirds of the total size of your git repositories. Efforts to reduce this
total are being tracked in this epic: [gitlab-org&153](https://gitlab.com/groups/gitlab-org/-/epics/153).
two-thirds of the total size of your Git repositories. Efforts to reduce this
total are being tracked in [epic &153](https://gitlab.com/groups/gitlab-org/-/epics/153).
## Enabling Elasticsearch
@ -341,27 +341,27 @@ Currently for repository and snippet files, GitLab would only index up to 1 MB o
There are several rake tasks available to you via the command line:
- [sudo gitlab-rake gitlab:elastic:index](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- [`sudo gitlab-rake gitlab:elastic:index`](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- This is a wrapper task. It does the following:
- `sudo gitlab-rake gitlab:elastic:create_empty_index`
- `sudo gitlab-rake gitlab:elastic:clear_index_status`
- `sudo gitlab-rake gitlab:elastic:index_projects`
- `sudo gitlab-rake gitlab:elastic:index_snippets`
- [sudo gitlab-rake gitlab:elastic:index_projects](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- [`sudo gitlab-rake gitlab:elastic:index_projects`](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- This iterates over all projects and queues sidekiq jobs to index them in the background.
- [sudo gitlab-rake gitlab:elastic:index_projects_status](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- [`sudo gitlab-rake gitlab:elastic:index_projects_status`](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- This determines the overall status of the indexing. It is done by counting the total number of indexed projects, dividing by a count of the total number of projects, then multiplying by 100.
- [sudo gitlab-rake gitlab:elastic:create_empty_index](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- [`sudo gitlab-rake gitlab:elastic:create_empty_index`](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- This generates an empty index on the Elasticsearch side.
- [sudo gitlab-rake gitlab:elastic:clear_index_status](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- [`sudo gitlab-rake gitlab:elastic:clear_index_status`](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- This deletes all instances of IndexStatus for all projects.
- [sudo gitlab-rake gitlab:elastic:delete_index](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- [`sudo gitlab-rake gitlab:elastic:delete_index`](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- This removes the GitLab index on the Elasticsearch instance.
- [sudo gitlab-rake gitlab:elastic:recreate_index](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- [`sudo gitlab-rake gitlab:elastic:recreate_index`](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- Does the same thing as `sudo gitlab-rake gitlab:elastic:create_empty_index`
- [sudo gitlab-rake gitlab:elastic:index_snippets](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- [`sudo gitlab-rake gitlab:elastic:index_snippets`](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- Performs an Elasticsearch import that indexes the snippets data.
- [sudo gitlab-rake gitlab:elastic:projects_not_indexed](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- [`sudo gitlab-rake gitlab:elastic:projects_not_indexed`](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- Displays which projects are not indexed.
### Environment Variables

4
doc/integration/facebook.md
View file

@ -49,7 +49,7 @@ To enable the Facebook OmniAuth provider you must register your application with
1. On your GitLab server, open the configuration file.
For omnibus package:
For Omnibus package:
```sh
sudo editor /etc/gitlab/gitlab.rb
@ -67,7 +67,7 @@ To enable the Facebook OmniAuth provider you must register your application with
1. Add the provider configuration:
For omnibus package:
For Omnibus package:
```ruby
gitlab_rails['omniauth_providers'] = [

6
doc/integration/github.md
View file

@ -36,7 +36,7 @@ To get the credentials (a pair of Client ID and Client Secret), you must registe
1. On your GitLab server, open the configuration file.
For omnibus package:
For Omnibus package:
```sh
sudo editor /etc/gitlab/gitlab.rb
@ -54,7 +54,7 @@ To get the credentials (a pair of Client ID and Client Secret), you must registe
1. Add the provider configuration:
For omnibus package:
For Omnibus package:
For GitHub.com:
@ -124,7 +124,7 @@ certificate and the imports are failing, you will need to disable SSL verificati
It should be disabled by adding `verify_ssl` to `false` in the provider configuration
and changing the global Git `sslVerify` option to `false` in the GitLab server.
For omnibus package:
For Omnibus package:
```ruby
gitlab_rails['omniauth_providers'] = [

4
doc/integration/gitlab.md
View file

@ -30,7 +30,7 @@ GitLab.com will generate an application ID and secret key for you to use.
1. On your GitLab server, open the configuration file.
For omnibus package:
For Omnibus package:
```sh
sudo editor /etc/gitlab/gitlab.rb
@ -48,7 +48,7 @@ GitLab.com will generate an application ID and secret key for you to use.
1. Add the provider configuration:
For omnibus package:
For Omnibus package:
```ruby
gitlab_rails['omniauth_providers'] = [

4
doc/integration/jenkins_deprecated.md
View file

@ -14,12 +14,12 @@ Integration includes:
Requirements:
- [Jenkins GitLab Hook plugin](https://wiki.jenkins.io/display/JENKINS/GitLab+Hook+Plugin)
- git clone access for Jenkins from GitLab repo (via ssh key)
- Git clone access for Jenkins from GitLab repo (via ssh key)
## Jenkins
1. Install [GitLab Hook plugin](https://wiki.jenkins.io/display/JENKINS/GitLab+Hook+Plugin)
1. Set up jenkins project
1. Set up Jenkins project
![screen](img/jenkins_project.png)

2
doc/integration/jira.md
View file

@ -2,4 +2,4 @@
redirect_to: '../user/project/integrations/jira.md'
---
This document was moved to [integrations/jira](../user/project/integrations/jira.md).
This document was moved to [another location](../user/project/integrations/jira.md).

2
doc/integration/jira_development_panel.md
View file

@ -23,7 +23,7 @@ or instance admin (in the case of self-hosted GitLab) set up the integration,
in order to simplify administration.
TIP: **Tip:**
Create and use a single-purpose "jira" user in GitLab, so that removing
Create and use a single-purpose `jira` user in GitLab, so that removing
regular users won't impact your integration.
## Requirements

7
doc/integration/kerberos.md
View file

@ -46,7 +46,7 @@ sudo chmod 0600 /etc/http.keytab
For source installations, make sure the `kerberos` gem group
[has been installed](../install/installation.md#install-gems).
1. Edit the kerberos section of [gitlab.yml] to enable Kerberos ticket-based
1. Edit the `kerberos` section of [`gitlab.yml`](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/config/gitlab.yml.example) to enable Kerberos ticket-based
authentication. In most cases, you only need to enable Kerberos and specify
the location of the keytab:
@ -153,7 +153,7 @@ keep offering only `basic` authentication.
listen [::]:8443 ipv6only=on ssl;
```
1. Update the Kerberos section of [gitlab.yml]:
1. Update the `kerberos` section of [`gitlab.yml`](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/config/gitlab.yml.example):
```yaml
kerberos:
@ -203,7 +203,7 @@ remove the OmniAuth provider named `kerberos` from your `gitlab.yml` /
**For installations from source**
1. Edit [gitlab.yml] and remove the `- { name: 'kerberos' }` line under omniauth
1. Edit [`gitlab.yml`](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/config/gitlab.yml.example) and remove the `- { name: 'kerberos' }` line under omniauth
providers:
```yaml
@ -295,7 +295,6 @@ See also: [Git v2.11 release notes](https://github.com/git/git/blob/master/Docum
- <http://blog.manula.org/2012/04/setting-up-kerberos-server-with-debian.html>
- <http://www.roguelynn.com/words/explain-like-im-5-kerberos/>
[gitlab.yml]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/config/gitlab.yml.example
[restart gitlab]: ../administration/restart_gitlab.md#installations-from-source
[reconfigure gitlab]: ../administration/restart_gitlab.md#omnibus-gitlab-reconfigure
[nginx]: http://nginx.org/en/docs/http/ngx_http_core_module.html#large_client_header_buffers

2
doc/integration/omniauth.md
View file

@ -69,7 +69,7 @@ that are in common for all providers that we need to consider.
To change these settings:
- **For omnibus package**
- **For Omnibus package**
Open the configuration file:

4
doc/integration/salesforce.md
View file

@ -29,7 +29,7 @@ To get the credentials (a pair of Client ID and Client Secret), you must [create
1. On your GitLab server, open the configuration file.
For omnibus package:
For Omnibus package:
```sh
sudo editor /etc/gitlab/gitlab.rb
@ -46,7 +46,7 @@ To get the credentials (a pair of Client ID and Client Secret), you must [create
1. Add the provider configuration:
For omnibus package:
For Omnibus package:
```ruby
gitlab_rails['omniauth_providers'] = [

10
doc/integration/saml.md
View file

@ -17,7 +17,7 @@ in your SAML IdP:
1. On your GitLab server, open the configuration file.
For omnibus package:
For Omnibus package:
```sh
sudo editor /etc/gitlab/gitlab.rb
@ -34,7 +34,7 @@ in your SAML IdP:
1. To allow your users to use SAML to sign up without having to manually create
an account first, don't forget to add the following values to your configuration:
For omnibus package:
For Omnibus package:
```ruby
gitlab_rails['omniauth_enabled'] = true
@ -54,7 +54,7 @@ in your SAML IdP:
1. You can also automatically link SAML users with existing GitLab users if their
email addresses match by adding the following setting:
For omnibus package:
For Omnibus package:
```ruby
gitlab_rails['omniauth_auto_link_saml_user'] = true
@ -68,7 +68,7 @@ in your SAML IdP:
1. Add the provider configuration:
For omnibus package:
For Omnibus package:
```ruby
gitlab_rails['omniauth_providers'] = [
@ -342,7 +342,7 @@ You can add this setting to your GitLab configuration to automatically redirect
to your SAML server for authentication, thus removing the need to click a button
before actually signing in.
For omnibus package:
For Omnibus package:
```ruby
gitlab_rails['omniauth_auto_sign_in_with_provider'] = 'saml'

16
doc/integration/shibboleth.md
View file

@ -1,18 +1,18 @@
# Shibboleth OmniAuth Provider
This documentation is for enabling shibboleth with omnibus-gitlab package.
This documentation is for enabling Shibboleth with the Omnibus GitLab package.
In order to enable Shibboleth support in gitlab we need to use Apache instead of Nginx (It may be possible to use Nginx, however this is difficult to configure using the bundled Nginx provided in the omnibus-gitlab package). Apache uses mod_shib2 module for shibboleth authentication and can pass attributes as headers to omniauth-shibboleth provider.
In order to enable Shibboleth support in GitLab we need to use Apache instead of Nginx (It may be possible to use Nginx, however this is difficult to configure using the bundled Nginx provided in the Omnibus GitLab package). Apache uses mod_shib2 module for Shibboleth authentication and can pass attributes as headers to Omniauth Shibboleth provider.
To enable the Shibboleth OmniAuth provider you must configure Apache shibboleth module.
To enable the Shibboleth OmniAuth provider you must configure Apache Shibboleth module.
The installation and configuration of the module itself is out of the scope of this document.
Check <https://wiki.shibboleth.net/confluence/display/SP3/Apache> for more info.
You can find Apache config in gitlab-recipes (<https://gitlab.com/gitlab-org/gitlab-recipes/tree/master/web-server/apache>).
You can find Apache config in [GitLab Recipes](https://gitlab.com/gitlab-org/gitlab-recipes/tree/master/web-server/apache).
The following changes are needed to enable Shibboleth:
1. Protect omniauth-shibboleth callback URL:
1. Protect Omniauth Shibboleth callback URL:
```
<Location /users/auth/shibboleth/callback>
@ -32,7 +32,7 @@ The following changes are needed to enable Shibboleth:
</Location>
```
1. Exclude shibboleth URLs from rewriting. Add `RewriteCond %{REQUEST_URI} !/Shibboleth.sso` and `RewriteCond %{REQUEST_URI} !/shibboleth-sp`. Config should look like this:
1. Exclude Shibboleth URLs from rewriting. Add `RewriteCond %{REQUEST_URI} !/Shibboleth.sso` and `RewriteCond %{REQUEST_URI} !/shibboleth-sp`. Config should look like this:
```
# Apache equivalent of Nginx try files
@ -50,7 +50,7 @@ The following changes are needed to enable Shibboleth:
attribute mapping. Therefore the values of the `args` hash
should be in the form of `"HTTP_ATTRIBUTE"`. The keys in the hash are arguments
to the [OmniAuth::Strategies::Shibboleth class](https://github.com/toyokazu/omniauth-shibboleth/blob/master/lib/omniauth/strategies/shibboleth.rb)
and are documented by the [omniauth-shibboleth gem](https://github.com/toyokazu/omniauth-shibboleth)
and are documented by the [`omniauth-shibboleth` gem](https://github.com/toyokazu/omniauth-shibboleth)
(take care to note the version of the gem packaged with GitLab). If some of
your users appear to be authenticated by Shibboleth and Apache, but GitLab
rejects their account with a URI that contains "e-mail is invalid" then your
@ -94,7 +94,7 @@ On the sign in page, there should now be a "Sign in with: Shibboleth" icon below
## Apache 2.4 / GitLab 8.6 update
The order of the first 2 Location directives is important. If they are reversed,
you will not get a shibboleth session!
you will not get a Shibboleth session!
```
<Location />

4
doc/integration/twitter.md
View file

@ -32,7 +32,7 @@ To enable the Twitter OmniAuth provider you must register your application with
1. On your GitLab server, open the configuration file.
For omnibus package:
For Omnibus package:
```sh
sudo editor /etc/gitlab/gitlab.rb
@ -50,7 +50,7 @@ To enable the Twitter OmniAuth provider you must register your application with
1. Add the provider configuration:
For omnibus package:
For Omnibus package:
```ruby
gitlab_rails['omniauth_providers'] = [

4
doc/integration/ultra_auth.md
View file

@ -25,7 +25,7 @@ To get the credentials (a pair of Client ID and Client Secret), you must registe
1. Select **Register application**.
1. On your GitLab server, open the configuration file.
For omnibus package:
For Omnibus package:
```sh
sudo editor /etc/gitlab/gitlab.rb
@ -41,7 +41,7 @@ To get the credentials (a pair of Client ID and Client Secret), you must registe
1. See [Initial OmniAuth Configuration](omniauth.md#initial-omniauth-configuration) for initial settings.
1. Add the provider configuration:
For omnibus package:
For Omnibus package:
```ruby
gitlab_rails['omniauth_providers'] = [

2
doc/project_services/bamboo.md
View file

@ -2,4 +2,4 @@
redirect_to: '../user/project/integrations/bamboo.md'
---
This document was moved to [user/project/integrations/bamboo.md](../user/project/integrations/bamboo.md).
This document was moved to [another location](../user/project/integrations/bamboo.md).

2
doc/project_services/bugzilla.md
View file

@ -2,4 +2,4 @@
redirect_to: '../user/project/integrations/bugzilla.md'
---
This document was moved to [user/project/integrations/bugzilla.md](../user/project/integrations/bugzilla.md).
This document was moved to [another location](../user/project/integrations/bugzilla.md).

2
doc/project_services/emails_on_push.md
View file

@ -2,4 +2,4 @@
redirect_to: '../user/project/integrations/emails_on_push.md'
---
This document was moved to [user/project/integrations/emails_on_push.md](../user/project/integrations/emails_on_push.md).
This document was moved to [another location](../user/project/integrations/emails_on_push.md).

6
doc/project_services/hipchat.md
View file

@ -1 +1,5 @@
This document was moved to [user/project/integrations/hipchat.md](../user/project/integrations/hipchat.md).
---
redirect_to: '../user/project/integrations/hipchat.md'
---
This document was moved to [another location](../user/project/integrations/hipchat.md).

2
doc/project_services/irker.md
View file

@ -2,4 +2,4 @@
redirect_to: '../user/project/integrations/irker.md'
---
This document was moved to [user/project/integrations/irker.md](../user/project/integrations/irker.md).
This document was moved to [another location](../user/project/integrations/irker.md).

2
doc/project_services/jira.md
View file

@ -2,4 +2,4 @@
redirect_to: '../user/project/integrations/jira.md'
---
This document was moved to [user/project/integrations/jira.md](../user/project/integrations/jira.md).
This document was moved to [another location](../user/project/integrations/jira.md).

2
doc/project_services/kubernetes.md
View file

@ -2,4 +2,4 @@
redirect_to: '../user/project/integrations/kubernetes.md'
---
This document was moved to [user/project/integrations/kubernetes.md](../user/project/integrations/kubernetes.md).
This document was moved to [another location](../user/project/integrations/kubernetes.md).

2
doc/project_services/mattermost.md
View file

@ -2,4 +2,4 @@
redirect_to: '../user/project/integrations/mattermost.md'
---
This document was moved to [user/project/integrations/mattermost.md](../user/project/integrations/mattermost.md).
This document was moved to [another location](../user/project/integrations/mattermost.md).

2
doc/project_services/mattermost_slash_commands.md
View file

@ -2,4 +2,4 @@
redirect_to: '../user/project/integrations/mattermost_slash_commands.md'
---
This document was moved to [user/project/integrations/mattermost_slash_commands.md](../user/project/integrations/mattermost_slash_commands.md).
This document was moved to [another location](../user/project/integrations/mattermost_slash_commands.md).

2
doc/project_services/project_services.md
View file

@ -2,4 +2,4 @@
redirect_to: '../user/project/integrations/project_services.md'
---
This document was moved to [user/project/integrations/project_services.md](../user/project/integrations/project_services.md).
This document was moved to [another location](../user/project/integrations/project_services.md).

2
doc/project_services/redmine.md
View file

@ -2,4 +2,4 @@
redirect_to: '../user/project/integrations/redmine.md'
---
This document was moved to [user/project/integrations/redmine.md](../user/project/integrations/redmine.md).
This document was moved to [another location](../user/project/integrations/redmine.md).

2
doc/project_services/services_templates.md
View file

@ -2,4 +2,4 @@
redirect_to: '../user/project/integrations/services_templates.md'
---
This document was moved to [user/project/integrations/services_templates.md](../user/project/integrations/services_templates.md).
This document was moved to [another location](../user/project/integrations/services_templates.md).

2
doc/project_services/slack.md
View file

@ -2,4 +2,4 @@
redirect_to: '../user/project/integrations/slack.md'
---
This document was moved to [user/project/integrations/slack.md](../user/project/integrations/slack.md).
This document was moved to [another location](../user/project/integrations/slack.md).

2
doc/project_services/slack_slash_commands.md
View file

@ -2,4 +2,4 @@
redirect_to: '../user/project/integrations/slack_slash_commands.md'
---
This document was moved to [user/project/integrations/slack_slash_commands.md](../user/project/integrations/slack_slash_commands.md).
This document was moved to [another location](../user/project/integrations/slack_slash_commands.md).

2
doc/raketasks/README.md
View file

@ -12,7 +12,7 @@ comments: false
- [General Maintenance](../administration/raketasks/maintenance.md) and self-checks
- [User management](user_management.md)
- [Webhooks](web_hooks.md)
- [Import](import.md) of git repositories in bulk
- [Import](import.md) of Git repositories in bulk
- [Rebuild authorized_keys file](../administration/raketasks/maintenance.md#rebuild-authorized_keys-file) task for administrators
- [Migrate Uploads](../administration/raketasks/uploads/migrate.md)
- [Sanitize Uploads](../administration/raketasks/uploads/sanitize.md)

14
doc/raketasks/backup_restore.md
View file

@ -94,7 +94,7 @@ docker exec -t <container name> gitlab-backup create
If you are using the [GitLab helm chart](https://gitlab.com/charts/gitlab) on a
Kubernetes cluster, you can run the backup task using `backup-utility` script on
the gitlab task runner pod via `kubectl`. Refer to [backing up a GitLab installation](https://gitlab.com/charts/gitlab/blob/master/doc/backup-restore/backup.md#backing-up-a-gitlab-installation) for more details:
the GitLab task runner pod via `kubectl`. Refer to [backing up a GitLab installation](https://gitlab.com/charts/gitlab/blob/master/doc/backup-restore/backup.md#backing-up-a-gitlab-installation) for more details:
```sh
kubectl exec -it <gitlab task-runner pod> backup-utility
@ -458,7 +458,7 @@ You may also send backups to a mounted share (`NFS` / `CIFS` / `SMB` / etc.) by
using the Fog [`Local`](https://github.com/fog/fog-local#usage) storage provider.
The directory pointed to by the `local_root` key **must** be owned by the `git`
user **when mounted** (mounting with the `uid=` of the `git` user for `CIFS` and
`SMB`) or the user that you are executing the backup tasks under (for omnibus
`SMB`) or the user that you are executing the backup tasks under (for Omnibus
packages, this is the `git` user).
The `backup_upload_remote_directory` **must** be set in addition to the
@ -507,7 +507,7 @@ For installations from source:
### Backup archive permissions
The backup archives created by GitLab (`1393513186_2014_02_27_gitlab_backup.tar`)
will have owner/group git:git and 0600 permissions by default.
will have owner/group `git`/`git` and 0600 permissions by default.
This is meant to avoid other system users reading GitLab's data.
If you need the backup archives to have different permissions you can use the 'archive_permissions' setting.
@ -614,7 +614,7 @@ GitLab that you created it on, for example CE 9.1.0.
You need to have a working GitLab installation before you can perform
a restore. This is mainly because the system user performing the
restore actions ('git') is usually not allowed to create or delete
restore actions (`git`) is usually not allowed to create or delete
the SQL database it needs to import data into ('gitlabhq_production').
All existing data will be either erased (SQL) or moved to a separate
directory (repositories, uploads).
@ -773,14 +773,14 @@ In this case you can consider using filesystem snapshots as part of your backup
Example: Amazon EBS
> A GitLab server using omnibus-gitlab hosted on Amazon AWS.
> A GitLab server using Omnibus GitLab hosted on Amazon AWS.
> An EBS drive containing an ext4 filesystem is mounted at `/var/opt/gitlab`.
> In this case you could make an application backup by taking an EBS snapshot.
> The backup includes all repositories, uploads and Postgres data.
Example: LVM snapshots + rsync
> A GitLab server using omnibus-gitlab, with an LVM logical volume mounted at `/var/opt/gitlab`.
> A GitLab server using Omnibus GitLab, with an LVM logical volume mounted at `/var/opt/gitlab`.
> Replicating the `/var/opt/gitlab` directory using rsync would not be reliable because too many files would change while rsync is running.
> Instead of rsync-ing `/var/opt/gitlab`, we create a temporary LVM snapshot, which we mount as a read-only filesystem at `/mnt/gitlab_backup`.
> Now we can have a longer running rsync job which will create a consistent replica on the remote server.
@ -804,7 +804,7 @@ will have all your repositories, but not any other data.
## Troubleshooting
### Restoring database backup using omnibus packages outputs warnings
### Restoring database backup using Omnibus packages outputs warnings
If you are using backup restore procedures you might encounter the following warnings:

2
doc/raketasks/features.md
View file

@ -6,7 +6,7 @@ This command will enable the namespaces feature introduced in v4.0. It will move
Note:
- Because the **repository location will change**, you will need to **update all your git URLs** to point to the new location.
- Because the **repository location will change**, you will need to **update all your Git URLs** to point to the new location.
- Username can be changed at **Profile ➔ Account**.
**Example:**

8
doc/raketasks/import.md
View file

@ -13,7 +13,7 @@
### Create a new folder to import your Git repositories from
The new folder needs to have git user ownership and read/write/execute access for git user and its group:
The new folder needs to have Git user ownership and read/write/execute access for Git user and its group:
```
sudo -u git mkdir -p /var/opt/gitlab/git-data/repository-import-<date>/new_group
@ -21,7 +21,7 @@ sudo -u git mkdir -p /var/opt/gitlab/git-data/repository-import-<date>/new_group
### Copy your bare repositories inside this newly created folder
- Any .git repositories found on any of the subfolders will be imported as projects
- Any `.git` repositories found on any of the subfolders will be imported as projects
- Groups will be created as needed, these could be nested folders. Example:
If we copy the repos to `/var/opt/gitlab/git-data/repository-import-<date>`, and repo A needs to be under the groups G1 and G2, it will
@ -34,7 +34,7 @@ sudo cp -r /old/git/foo.git /var/opt/gitlab/git-data/repository-import-<date>/ne
sudo chown -R git:git /var/opt/gitlab/git-data/repository-import-<date>
```
`foo.git` needs to be owned by the git user and git users group.
`foo.git` needs to be owned by the `git` user and `git` users group.
If you are using an installation from source, replace `/var/opt/gitlab/` with `/home/git`.
@ -96,7 +96,7 @@ Importing bare repositories from hashed storage is unsupported.
To support importing bare repositories from hashed storage, GitLab 10.4 and
later stores the full project path with each repository, in a special section of
the git repository's config file. This section is formatted as follows:
the Git repository's config file. This section is formatted as follows:
```
[gitlab]