gitlab-org--gitlab-foss/doc/raketasks/maintenance.md

# Maintenance

## 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.

```
# omnibus-gitlab
sudo gitlab-rake gitlab:env:info

# installation from source or cookbook
bundle exec rake gitlab:env:info RAILS_ENV=production
```

Example output:

```
System information
System:		Debian 6.0.7
Current User:	git
Using RVM:	no
Ruby Version: 2.0.0-p481
Gem Version:  1.8.23
Bundler Version:1.3.5
Rake Version:	10.0.4

GitLab information
Version:	5.1.0.beta2
Revision:	4da8b37
Directory:	/home/git/gitlab
DB Adapter:	mysql2
URL:		http://example.com
HTTP Clone URL:	http://example.com/some-project.git
SSH Clone URL:	git@example.com:some-project.git
Using LDAP:	no
Using Omniauth:	no

GitLab Shell
Version:	1.2.0
Repositories:	/home/git/repositories/
Hooks:		/home/git/gitlab-shell/hooks/
Git:		/usr/bin/git
```

## Check GitLab configuration

Runs the following rake tasks:

- `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.

You may also have a look at our [Trouble Shooting Guide](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Trouble-Shooting-Guide).

```
# omnibus-gitlab
sudo gitlab-rake gitlab:check

# installation from source or cookbook
bundle exec rake gitlab:check RAILS_ENV=production
```

NOTE: Use SANITIZE=true for gitlab:check if you want to omit project names from the output.

Example output:

```
Checking Environment ...

Git configured for git user? ... yes
Has python2? ... yes
python2 is supported version? ... yes

Checking Environment ... Finished

Checking GitLab Shell ...

GitLab Shell version? ... OK (1.2.0)
Repo base directory exists? ... yes
Repo base directory is a symlink? ... no
Repo base owned by git:git? ... yes
Repo base access is drwxrws---? ... yes
post-receive hook up-to-date? ... yes
post-receive hooks in repos are links: ... yes

Checking GitLab Shell ... Finished

Checking Sidekiq ...

Running? ... yes

Checking Sidekiq ... Finished

Checking GitLab ...

Database config exists? ... yes
Database is SQLite ... no
All migrations up? ... yes
GitLab config exists? ... yes
GitLab config outdated? ... no
Log directory writable? ... yes
Tmp directory writable? ... yes
Init script exists? ... yes
Init script up-to-date? ... yes
Projects have satellites? ... yes
Redis version >= 2.0.0? ... yes

Checking GitLab ... Finished
```

## (Re-)Create satellite repositories

This will create satellite repositories for all your projects.

If necessary, remove the `repo_satellites` directory and rerun the commands below.

```
sudo -u git -H mkdir -p /home/git/gitlab-satellites
sudo -u git -H bundle exec rake gitlab:satellites:create RAILS_ENV=production
sudo chmod u+rwx,g=rx,o-rwx /home/git/gitlab-satellites
```
Add titles to doc pages. 2014-05-27 12:12:15 +00:00			`# Maintenance`

Update docs to markdown style guide. 2014-04-24 22:48:22 +00:00			`## Gather information about GitLab and the system it runs on`
add rake task to gather system information 2012-12-05 17:27:54 +00:00
Update docs to markdown style guide. 2014-04-24 22:48:22 +00:00			`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.`
add rake task to gather system information 2012-12-05 17:27:54 +00:00
			```
Spell out rake tasks for omnibus-gitlab 2014-06-23 08:38:22 +00:00			`# omnibus-gitlab`
			`sudo gitlab-rake gitlab:env:info`

			`# installation from source or cookbook`
Add RAILS_ENV to rake docs 2013-01-05 21:36:04 +00:00			`bundle exec rake gitlab:env:info RAILS_ENV=production`
add rake task to gather system information 2012-12-05 17:27:54 +00:00			```

			`Example output:`

			```
			`System information`
Added check_redis_version. Fixes #3449 Checking the redis version will warn users that are using an old version to update. Included reference to the troubleshooting guide. 2013-04-14 20:17:06 +00:00			`System: Debian 6.0.7`
			`Current User: git`
			`Using RVM: no`
Ruby 2.0+ is a requirement. 2014-05-27 10:47:09 +00:00			`Ruby Version: 2.0.0-p481`
			`Gem Version: 1.8.23`
Added check_redis_version. Fixes #3449 Checking the redis version will warn users that are using an old version to update. Included reference to the troubleshooting guide. 2013-04-14 20:17:06 +00:00			`Bundler Version:1.3.5`
			`Rake Version: 10.0.4`
Improve gitlab:env:info task Renamed from gitlab:app:info Add several extra info points 2012-12-06 20:16:48 +00:00
			`GitLab information`
Added check_redis_version. Fixes #3449 Checking the redis version will warn users that are using an old version to update. Included reference to the troubleshooting guide. 2013-04-14 20:17:06 +00:00			`Version: 5.1.0.beta2`
			`Revision: 4da8b37`
			`Directory: /home/git/gitlab`
			`DB Adapter: mysql2`
Update the examples to example.com 2014-05-16 10:57:32 +00:00			`URL: http://example.com`
			`HTTP Clone URL: http://example.com/some-project.git`
			`SSH Clone URL: git@example.com:some-project.git`
Added check_redis_version. Fixes #3449 Checking the redis version will warn users that are using an old version to update. Included reference to the troubleshooting guide. 2013-04-14 20:17:06 +00:00			`Using LDAP: no`
			`Using Omniauth: no`
add rake task to gather system information 2012-12-05 17:27:54 +00:00
Remove gitolite mention from docs 2013-02-25 19:45:33 +00:00			`GitLab Shell`
Added check_redis_version. Fixes #3449 Checking the redis version will warn users that are using an old version to update. Included reference to the troubleshooting guide. 2013-04-14 20:17:06 +00:00			`Version: 1.2.0`
			`Repositories: /home/git/repositories/`
			`Hooks: /home/git/gitlab-shell/hooks/`
			`Git: /usr/bin/git`
add rake task to gather system information 2012-12-05 17:27:54 +00:00			```

Update docs to markdown style guide. 2014-04-24 22:48:22 +00:00			`## Check GitLab configuration`
add help page for gitlab specific rake tasks 2012-12-02 12:56:04 +00:00
Update gitlab:check task docs 2012-12-12 22:55:09 +00:00			`Runs the following rake tasks:`

Update docs to markdown style guide. 2014-04-24 22:48:22 +00:00			- `gitlab:env:check`
			- `gitlab:gitlab_shell:check`
			- `gitlab:sidekiq:check`
			- `gitlab:app:check`
Update gitlab:check task docs 2012-12-12 22:55:09 +00:00
			`It will check that each component was setup according to the installation guide and suggest fixes for issues found.`

			`You may also have a look at our [Trouble Shooting Guide](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Trouble-Shooting-Guide).`
add help page for gitlab specific rake tasks 2012-12-02 12:56:04 +00:00
			```
Spell out rake tasks for omnibus-gitlab 2014-06-23 08:38:22 +00:00			`# omnibus-gitlab`
			`sudo gitlab-rake gitlab:check`

			`# installation from source or cookbook`
Add RAILS_ENV to rake docs 2013-01-05 21:36:04 +00:00			`bundle exec rake gitlab:check RAILS_ENV=production`
add help page for gitlab specific rake tasks 2012-12-02 12:56:04 +00:00			```

Add sanitize option to documentation. 2014-07-07 12:41:02 +00:00			`NOTE: Use SANITIZE=true for gitlab:check if you want to omit project names from the output.`

add help page for gitlab specific rake tasks 2012-12-02 12:56:04 +00:00			`Example output:`

			```
Update gitlab:check task docs 2012-12-12 22:55:09 +00:00			`Checking Environment ...`

Added check_redis_version. Fixes #3449 Checking the redis version will warn users that are using an old version to update. Included reference to the troubleshooting guide. 2013-04-14 20:17:06 +00:00			`Git configured for git user? ... yes`
Update gitlab:check task docs 2012-12-12 22:55:09 +00:00			`Has python2? ... yes`
			`python2 is supported version? ... yes`

			`Checking Environment ... Finished`

changed Gitlab to GitLab 2013-05-19 09:13:39 +00:00			`Checking GitLab Shell ...`
Update gitlab:check task docs 2012-12-12 22:55:09 +00:00
Added check_redis_version. Fixes #3449 Checking the redis version will warn users that are using an old version to update. Included reference to the troubleshooting guide. 2013-04-14 20:17:06 +00:00			`GitLab Shell version? ... OK (1.2.0)`
Update gitlab:check task docs 2012-12-12 22:55:09 +00:00			`Repo base directory exists? ... yes`
Added check_redis_version. Fixes #3449 Checking the redis version will warn users that are using an old version to update. Included reference to the troubleshooting guide. 2013-04-14 20:17:06 +00:00			`Repo base directory is a symlink? ... no`
Update gitlab:check task docs 2012-12-12 22:55:09 +00:00			`Repo base owned by git:git? ... yes`
Don't setuid the repositories (Rake checks) 2012-12-31 02:46:28 +00:00			`Repo base access is drwxrws---? ... yes`
Update gitlab:check task docs 2012-12-12 22:55:09 +00:00			`post-receive hook up-to-date? ... yes`
Added check_redis_version. Fixes #3449 Checking the redis version will warn users that are using an old version to update. Included reference to the troubleshooting guide. 2013-04-14 20:17:06 +00:00			`post-receive hooks in repos are links: ... yes`
Update gitlab:check task docs 2012-12-12 22:55:09 +00:00
changed Gitlab to GitLab 2013-05-19 09:13:39 +00:00			`Checking GitLab Shell ... Finished`
Update gitlab:check task docs 2012-12-12 22:55:09 +00:00
Added check_redis_version. Fixes #3449 Checking the redis version will warn users that are using an old version to update. Included reference to the troubleshooting guide. 2013-04-14 20:17:06 +00:00			`Checking Sidekiq ...`
Update gitlab:check task docs 2012-12-12 22:55:09 +00:00
			`Running? ... yes`

Added check_redis_version. Fixes #3449 Checking the redis version will warn users that are using an old version to update. Included reference to the troubleshooting guide. 2013-04-14 20:17:06 +00:00			`Checking Sidekiq ... Finished`
Update gitlab:check task docs 2012-12-12 22:55:09 +00:00
			`Checking GitLab ...`

			`Database config exists? ... yes`
Added check_redis_version. Fixes #3449 Checking the redis version will warn users that are using an old version to update. Included reference to the troubleshooting guide. 2013-04-14 20:17:06 +00:00			`Database is SQLite ... no`
Update gitlab:check task docs 2012-12-12 22:55:09 +00:00			`All migrations up? ... yes`
			`GitLab config exists? ... yes`
Added check_redis_version. Fixes #3449 Checking the redis version will warn users that are using an old version to update. Included reference to the troubleshooting guide. 2013-04-14 20:17:06 +00:00			`GitLab config outdated? ... no`
Update gitlab:check task docs 2012-12-12 22:55:09 +00:00			`Log directory writable? ... yes`
			`Tmp directory writable? ... yes`
			`Init script exists? ... yes`
			`Init script up-to-date? ... yes`
Added check_redis_version. Fixes #3449 Checking the redis version will warn users that are using an old version to update. Included reference to the troubleshooting guide. 2013-04-14 20:17:06 +00:00			`Projects have satellites? ... yes`
			`Redis version >= 2.0.0? ... yes`
Update gitlab:check task docs 2012-12-12 22:55:09 +00:00
			`Checking GitLab ... Finished`
add help page for gitlab specific rake tasks 2012-12-02 12:56:04 +00:00			```

Fix spelling errors in doc, closes #7437 Further changes 2014-08-04 20:32:41 +00:00			`## (Re-)Create satellite repositories`
Add gitlab:satellites:create as an alias for gitlab:enable_automerge 2012-12-20 20:52:26 +00:00
Fix spelling errors in doc, closes #7437 Further changes 2014-08-04 20:32:41 +00:00			`This will create satellite repositories for all your projects.`
Update docs to markdown style guide. 2014-04-24 22:48:22 +00:00
update repo recreation details 2014-09-02 05:48:57 +00:00			If necessary, remove the `repo_satellites` directory and rerun the commands below.
Add gitlab:satellites:create as an alias for gitlab:enable_automerge 2012-12-20 20:52:26 +00:00
			```
update repo recreation details 2014-09-02 05:48:57 +00:00			`sudo -u git -H mkdir -p /home/git/gitlab-satellites`
			`sudo -u git -H bundle exec rake gitlab:satellites:create RAILS_ENV=production`
			`sudo chmod u+rwx,g=rx,o-rwx /home/git/gitlab-satellites`
Add gitlab:satellites:create as an alias for gitlab:enable_automerge 2012-12-20 20:52:26 +00:00			```