Standalone Redis using the Linux package
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
The Linux package can be used to configure a standalone Redis server. In this configuration, Redis is not scaled, and represents a single point of failure. However, in a scaled environment the objective is to allow the environment to handle more users or to increase throughput. Redis itself is generally stable and can handle many requests, so it is an acceptable trade off to have only a single instance. See the reference architectures page for an overview of GitLab scaling options.
Set up the standalone Redis instance
The steps below are the minimum necessary to configure a Redis server with the Linux package:
SSH into the Redis server.
Download and install the Linux package you want by using steps 1 and 2 from the GitLab downloads page. Do not complete any other steps on the download page.
Edit
/etc/gitlab/gitlab.rb
and add the contents:## Enable Redis and disable all other services ## https://docs.gitlab.com/omnibus/roles/ roles ['redis_master_role'] ## Redis configuration redis['bind'] = '0.0.0.0' redis['port'] = 6379 redis['password'] = '<redis_password>' ## Disable automatic database migrations ## Only the primary GitLab application server should handle migrations gitlab_rails['auto_migrate'] = false
Reconfigure GitLab for the changes to take effect.
Note the Redis node’s IP address or hostname, port, and Redis password. These are necessary when configuring the GitLab application servers.
Advanced configuration options are supported and can be added if needed.
Set up the GitLab Rails application instance
On the instance where GitLab is installed:
Edit the
/etc/gitlab/gitlab.rb
file and add the following contents:## Disable Redis redis['enable'] = false gitlab_rails['redis_host'] = 'redis.example.com' gitlab_rails['redis_port'] = 6379 ## Required if Redis authentication is configured on the Redis node gitlab_rails['redis_password'] = '<redis_password>'
Save your changes to
/etc/gitlab/gitlab.rb
.Reconfigure GitLab for the changes to take effect.
Troubleshooting
See the Redis troubleshooting guide.
Docs
Edit this page to fix an error or add an improvement in a merge request.
Create an issue to suggest an improvement to this page.
Product
Create an issue if there's something you don't like about this feature.
Propose functionality by submitting a feature request.
Feature availability and product trials
View pricing to see all GitLab tiers and features, or to upgrade.
Try GitLab for free with access to all features for 30 days.
Get help
If you didn't find what you were looking for, search the docs.
If you want help with something specific and could use community support, post on the GitLab forum.
For problems setting up or using this feature (depending on your GitLab subscription).
Request support