diff --git a/.markdownlint.json b/.markdownlint.json index e56e32dcb7b6820db9f6e606d46f90d948d333b4_Lm1hcmtkb3dubGludC5qc29u..98e0d2ce836dbb443e7ec7fddf6700a480eee4d3_Lm1hcmtkb3dubGludC5qc29u 100644 --- a/.markdownlint.json +++ b/.markdownlint.json @@ -62,6 +62,7 @@ "Gmail", "Google", "Grafana", + "Gzip", "Helm", "HipChat", "Ingress", diff --git a/doc/.vale/gitlab/Spelling.yml b/doc/.vale/gitlab/Spelling.yml new file mode 100644 index 0000000000000000000000000000000000000000..98e0d2ce836dbb443e7ec7fddf6700a480eee4d3_ZG9jLy52YWxlL2dpdGxhYi9TcGVsbGluZy55bWw= --- /dev/null +++ b/doc/.vale/gitlab/Spelling.yml @@ -0,0 +1,15 @@ +--- +# Checks for possible spelling mistakes in content, not code. May find false positives +# due to links using angle brackets: <https://example.com>. These can be ignored. +# +# If a word is flagged as a spelling mistake incorrectly, such as a product name, +# you can submit an MR to update `spelling-exceptions.txt` with the missing word. +# Commands, like `git clone` must use backticks, and must not be added to the +# exceptions. +# +# For a list of all options, see https://errata-ai.github.io/vale/styles/ +extends: spelling +message: 'Spelling check: "%s"?' +level: warning +ignore: + - gitlab/spelling-exceptions.txt diff --git a/doc/.vale/gitlab/SubstitutionWarning.yml b/doc/.vale/gitlab/SubstitutionWarning.yml new file mode 100644 index 0000000000000000000000000000000000000000..98e0d2ce836dbb443e7ec7fddf6700a480eee4d3_ZG9jLy52YWxlL2dpdGxhYi9TdWJzdGl0dXRpb25XYXJuaW5nLnltbA== --- /dev/null +++ b/doc/.vale/gitlab/SubstitutionWarning.yml @@ -0,0 +1,16 @@ +--- +# Warns against using common shorthand for terms. +# For substitutions flagged as errors, see Substitutions.yml +# +# For a list of all options, see https://errata-ai.github.io/vale/styles/ +extends: substitution +message: 'If possible, use "%s" instead of "%s".' +link: https://about.gitlab.com/handbook/communication/#top-misused-terms +level: warning +ignorecase: true +swap: + admin: administrator + config: configuration + distro: distribution + info: information + repo: repository diff --git a/doc/.vale/gitlab/Substitutions.yml b/doc/.vale/gitlab/Substitutions.yml index e56e32dcb7b6820db9f6e606d46f90d948d333b4_ZG9jLy52YWxlL2dpdGxhYi9TdWJzdGl0dXRpb25zLnltbA==..98e0d2ce836dbb443e7ec7fddf6700a480eee4d3_ZG9jLy52YWxlL2dpdGxhYi9TdWJzdGl0dXRpb25zLnltbA== 100644 --- a/doc/.vale/gitlab/Substitutions.yml +++ b/doc/.vale/gitlab/Substitutions.yml @@ -1,5 +1,6 @@ --- # Checks for use of some of the top misused terms at GitLab. +# For substitutions only flagged as warnings, see SubstitutionWarning.yml # # For a list of all options, see https://errata-ai.github.io/vale/styles/ extends: substitution @@ -9,6 +10,7 @@ ignorecase: true swap: GitLabber: GitLab team member + gitlab omnibus: Omnibus GitLab param: parameter params: parameters postgres: PostgreSQL @@ -17,4 +19,5 @@ rspec: RSpec self hosted: self-managed self-hosted: self-managed + x509: X.509 yaml: YAML diff --git a/doc/.vale/gitlab/spelling-exceptions.txt b/doc/.vale/gitlab/spelling-exceptions.txt new file mode 100644 index 0000000000000000000000000000000000000000..98e0d2ce836dbb443e7ec7fddf6700a480eee4d3_ZG9jLy52YWxlL2dpdGxhYi9zcGVsbGluZy1leGNlcHRpb25zLnR4dA== --- /dev/null +++ b/doc/.vale/gitlab/spelling-exceptions.txt @@ -0,0 +1,432 @@ +Akismet +Alertmanager +Algolia +Ansible +Anthos +API +approvers +Artifactory +Asana +Asciidoctor +Atlassian +Auth0 +Authentiq +autocomplete +autocompleted +autocompletes +autocompleting +autogenerated +autoloaded +autoloader +autoloading +autoscale +autoscaled +autoscaler +autoscales +autoscaling +awardable +Azure +backport +backported +backporting +backports +backtrace +backtraced +backtraces +backtracing +Bamboo +Bitbucket +blockquote +blockquoted +blockquotes +blockquoting +boolean +browsable +Bugzilla +Buildkite +buildpack +buildpacks +bundler +bundlers +burndown +cacheable +CAS +CentOS +Chatops +Citrix +Cloudwatch +Cobertura +Cognito +colocated +colocating +compilable +composable +Conda +Consul +cron +crons +crontab +crontabs +crosslinked +crosslinking +crosslinks +Crossplane +CrowdIn +Debian +deduplicate +deduplicated +deduplicates +deduplicating +deduplication +deprovision +deprovisioned +deprovisioning +deprovisions +discoverability +Disqus +Dockerfile +Dockerfiles +dotenv +downvoted +downvotes +Dpl +Dreamweaver +Elasticsearch +enablement +enqueued +expirable +Facebook +failover +failovers +failsafe +favicon +firewalled +Flowdock +Fluentd +Forgerock +Gantt +Gemnasium +Git +Gitaly +Gitea +GitHub +GitLab +gitlabsos +Gitter +Gmail +Google +Gradle +Grafana +gravatar +Gzip +hardcode +hardcoded +hardcodes +heatmap +heatmaps +Helm +Heroku +Herokuish +HipChat +hostname +hostnames +hotfix +hotfixed +hotfixes +hotfixing +http +https +idempotence +Ingress +initializer +initializers +interdependencies +interdependency +interruptible +Irker +Istio +jasmine-jquery +JavaScript +Jaeger +Jenkins +Jira +jQuery +JupyterHub +kanban +kanbans +Karma +Kerberos +Kibana +Knative +Kramdown +Kubernetes +Laravel +LDAP +Libravatar +Lograge +lookahead +lookaheads +lookbehind +lookbehinds +lookups +Lucene +Maildir +Makefile +Makefiles +Markdown +markdownlint +Mattermost +mbox +mergeable +Microsoft +middleware +middlewares +Minikube +MinIO +mitmproxy +misconfigure +misconfigured +misconfigures +misconfiguration +misconfigurations +misconfiguring +mitigations +mockup +mockups +ModSecurity +nameserver +nameservers +namespace +namespaced +namespaces +Nanoc +NGINX +npm +Nurtch +OAuth +Okta +offboarded +offboarding +offboards +OmniAuth +OpenID +OpenShift +Packagist +parallelization +parallelizations +performant +Pipfile +Pipfiles +Piwik +PgBouncer +plaintext +PostgreSQL +precompile +preconfigure +preconfigured +preconfigures +prefill +prefilled +prefilling +prefills +prepend +prepended +prepends +Pritaly +profiler +Prometheus +proxied +proxies +proxying +Pseudonymized +Pseudonymizer +Puma +Python +Qualys +Rackspace +Raketask +Raketasks +reachability +rebase +rebased +rebases +rebasing +Redcarpet +Redis +Redmine +reCAPTCHA +referer +referers +reindex +reindexed +reindexes +reindexing +relicensing +remediations +Repmgr +Repmgrd +requeue +requeued +requeues +reusability +resynced +resyncing +resyncs +rollout +rollouts +rsync +rsynced +rsyncing +rsyncs +resync +reverified +reverifies +reverify +Rubix +runbook +runbooks +runit +runtime +runtimes +Salesforce +SAML +sbt +Sendmail +Sentry +serverless +Sidekiq +sharding +shfmt +Shibboleth +sanitization +serializer +serializers +serializing +Slack +Slony +SMTP +Sourcegraph +spidering +Splunk +SSH +storable +strace +strikethrough +strikethroughs +subpath +subfolder +subfolders +subgraph +subgraphs +sublicense +sublicensed +sublicenses +sublicensing +subnet +subnets +subnetting +subtree +subtrees +subqueried +subqueries +subquery +subquerying +substring +substrings +syslog +Tiller +todos +tokenizer +Tokenizers +tokenizing +toolchain +toolchains +tooltip +tooltips +Trello +triaging +TypeScript +Twitter +Ubuntu +unarchive +unarchived +unarchives +Unassign +Unassigns +uncheck +unchecked +unchecking +unchecks +uncomment +uncommented +uncommenting +unencode +unencoded +unencoder +unencodes +unencrypted +Unicorn +unindexed +unlink +unlinking +unlinks +unmergeable +unmerged +unmerges +unmerging +unoptimize +unoptimized +unoptimizes +unoptimizing +unprioritized +unprotect +unprotects +unprotected +unpublish +unpublished +unpublishes +unpublishing +unreferenced +unresolve +unresolved +unresolving +unschedule +unstage +unstaged +unstages +unstaging +unstash +unstashed +unstashing +untarred +untracked +untrusted +unverified +unverifies +unverify +unverifying +uploader +uploaders +upvoted +upvotes +validator +validators +vendored +virtualized +virtualizing +Vue +Vuex +walkthrough +walkthroughs +WebdriverIO +webpack +webserver +whitepaper +whitepapers +Wireshark +Wordpress +Xcode +Xeon +YouTrack +Zeitwerk +Zendesk diff --git a/doc/build/prepare-build-environment.md b/doc/build/prepare-build-environment.md index e56e32dcb7b6820db9f6e606d46f90d948d333b4_ZG9jL2J1aWxkL3ByZXBhcmUtYnVpbGQtZW52aXJvbm1lbnQubWQ=..98e0d2ce836dbb443e7ec7fddf6700a480eee4d3_ZG9jL2J1aWxkL3ByZXBhcmUtYnVpbGQtZW52aXJvbm1lbnQubWQ= 100644 --- a/doc/build/prepare-build-environment.md +++ b/doc/build/prepare-build-environment.md @@ -13,8 +13,8 @@ > for your container runtime. Docker for Mac and Docker for Windows are known to set > this value to 2GB for default installations. -1. Pull the docker image for the OS you need to build package for - [GitLab Omnibus builder registry](https://gitlab.com/gitlab-org/gitlab-omnibus-builder/container_registry) +1. Pull the Docker image for the OS you need to build a package for. + [`gitlab-omnibus-builder` registry](https://gitlab.com/gitlab-org/gitlab-omnibus-builder/container_registry) contains images for all the supported OSs and versions. You can use one of them to build a package for it. For example, to prepare a build environment for Debian Stretch, you have to pull its image. The revision of the image to @@ -44,7 +44,7 @@ <https://dev.gitlab.org>. These repositories are specified in the `.custom_sources.yml` file (specified by `remote` key) in the root of the source tree and will be used by default. Since these repositories are not publicly usable, for - personal builds you have to use public alternatives of these repos. The + personal builds you have to use public alternatives of these repositories. The alternatives are also provided in the same file, specified by `alternative` key. The selection between these two is controlled by `ALTERNATIVE_SOURCES` environment variable, which can be set either `true` or `false`. If that diff --git a/doc/development/new-services.md b/doc/development/new-services.md index e56e32dcb7b6820db9f6e606d46f90d948d333b4_ZG9jL2RldmVsb3BtZW50L25ldy1zZXJ2aWNlcy5tZA==..98e0d2ce836dbb443e7ec7fddf6700a480eee4d3_ZG9jL2RldmVsb3BtZW50L25ldy1zZXJ2aWNlcy5tZA== 100644 --- a/doc/development/new-services.md +++ b/doc/development/new-services.md @@ -18,7 +18,7 @@ ## Add a top-level configuration object for the service The cookbooks and recipes located in `files/gitlab-cookbooks` are what get run during -`gitlab-ctl reconfigure` in instances where the GitLab Omnibus package has been +`gitlab-ctl reconfigure` in instances where the Omnibus GitLab package has been installed. This is where we will need to add the settings for a new service. ### Define the default attributes @@ -39,11 +39,11 @@ - `default` is how you define basic cookbook attributes. - `['gitlab']` contains the cookbook name. - `['best-service']` is the name of your service, at this level we use hyphens to separate words. -- `enable`, `dir`, and `log_directory` are our config settings, and we use underscores to separate words at this and deeper levels. -- `/var/opt/gitlab` is where the working directory and config files for the services are placed. +- `enable`, `dir`, and `log_directory` are our configuration settings, and we use underscores to separate words at this and deeper levels. +- `/var/opt/gitlab` is where the working directory and configuration files for the services are placed. - `/var/log/gitlab` is where logs are written to for the GitLab package. Define all your settings that you want configurable in the package here. Default them to `nil` if you need to calculate their defaults based on other settings for now. @@ -44,10 +44,10 @@ - `/var/log/gitlab` is where logs are written to for the GitLab package. Define all your settings that you want configurable in the package here. Default them to `nil` if you need to calculate their defaults based on other settings for now. -### Create a config Mash for your service +### Create a configuration Mash for your service In order for user to be able to configure your service from `/etc/gitlab/gitlab.rb` you will need to add a top level Mash for the service. @@ -74,8 +74,8 @@ ### Add service configuration to the settings template -We maintain a [global config template](../architecture/README.md#global-gitlab-configuration-template) +We maintain a [global configuration template](../architecture/README.md#global-gitlab-configuration-template) where examples of how to configure the services are available, commented out. This file becomes the `/etc/gitlab/gitlab.rb` on fresh installs of the package. @@ -78,8 +78,8 @@ where examples of how to configure the services are available, commented out. This file becomes the `/etc/gitlab/gitlab.rb` on fresh installs of the package. -Once you want to expose your service's config to user for them to change, add it +Once you want to expose your service's configuration to users for them to change, add it to this file. `files/gitlab-config-template/gitlab.rb.template` ```ruby @@ -208,7 +208,7 @@ ## Additional configuration parsing for the service -If you want to populate certain config options based on other options being set +If you want to populate certain configuration options based on other options being set by the user, we add a library for your service to parse variables. The library should be added as `files/gitlab-cookbooks/<cookbook name>/libraries/<service-name>.rb` @@ -225,7 +225,7 @@ end ``` -We then need to have the GitLab config call your parse_variables method. +We then need to have the GitLab configuration call your parse_variables method. Go into `files/gitlab-cookbooks/package/libraries/config/gitlab.rb` and update your attribute to use the library. diff --git a/doc/gitlab-mattermost/README.md b/doc/gitlab-mattermost/README.md index e56e32dcb7b6820db9f6e606d46f90d948d333b4_ZG9jL2dpdGxhYi1tYXR0ZXJtb3N0L1JFQURNRS5tZA==..98e0d2ce836dbb443e7ec7fddf6700a480eee4d3_ZG9jL2dpdGxhYi1tYXR0ZXJtb3N0L1JFQURNRS5tZA== 100644 --- a/doc/gitlab-mattermost/README.md +++ b/doc/gitlab-mattermost/README.md @@ -274,8 +274,14 @@ If this is not the case, there are two options: -1. Update [`gitlab.rb`](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/files/gitlab-config-template/gitlab.rb.template#L706) with the changes done to `config.json`. This might require adding some parameters as not all settings in `config.json` are available in `gitlab.rb`. Once complete, GitLab omnibus should be able to upgrade GitLab Mattermost from one version to the next. -1. Migrate Mattermost outside of the directory controlled by GitLab omnibus so it can be administered and upgraded independently. Follow the [Mattermost Migration Guide](https://docs.mattermost.com/administration/migrating.html) to move your Mattermost configuration settings and data to another directory or server independent from GitLab Omnibus. +1. Update [`gitlab.rb`](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/files/gitlab-config-template/gitlab.rb.template#L706) + with the changes done to `config.json`. This might require adding some parameters as not all + settings in `config.json` are available in `gitlab.rb`. Once complete, Omnibus GitLab should be + able to upgrade GitLab Mattermost from one version to the next. +1. Migrate Mattermost outside of the directory controlled by Omnibus GitLab so it can be administered + and upgraded independently. Follow the [Mattermost Migration Guide](https://docs.mattermost.com/administration/migrating.html) + to move your Mattermost configuration settings and data to another directory or server independent + from Omnibus GitLab. For a complete list of upgrade notices and special considerations for older versions, see the [Mattermost documentation](https://docs.mattermost.com/administration/important-upgrade-notes.html). diff --git a/doc/installation/index.md b/doc/installation/index.md index e56e32dcb7b6820db9f6e606d46f90d948d333b4_ZG9jL2luc3RhbGxhdGlvbi9pbmRleC5tZA==..98e0d2ce836dbb443e7ec7fddf6700a480eee4d3_ZG9jL2luc3RhbGxhdGlvbi9pbmRleC5tZA== 100644 --- a/doc/installation/index.md +++ b/doc/installation/index.md @@ -19,7 +19,7 @@ ## Installation and Configuration -These configuration settings are commonly used when configuring GitLab Omnibus. +These configuration settings are commonly used when configuring Omnibus GitLab. For a complete list of settings, see the [README](../README.md#configuring) file. - [Installing GitLab](https://about.gitlab.com/install/). diff --git a/doc/package-information/omnibus_packages.md b/doc/package-information/omnibus_packages.md index e56e32dcb7b6820db9f6e606d46f90d948d333b4_ZG9jL3BhY2thZ2UtaW5mb3JtYXRpb24vb21uaWJ1c19wYWNrYWdlcy5tZA==..98e0d2ce836dbb443e7ec7fddf6700a480eee4d3_ZG9jL3BhY2thZ2UtaW5mb3JtYXRpb24vb21uaWJ1c19wYWNrYWdlcy5tZA== 100644 --- a/doc/package-information/omnibus_packages.md +++ b/doc/package-information/omnibus_packages.md @@ -13,7 +13,7 @@ 1. Support for a wide variety of operating systems 1. Wide support of cloud service providers -## GitLab Omnibus Architecture +## Omnibus GitLab Architecture GitLab in its core is a Ruby on Rails project. However, GitLab as a whole application is more complex and has multiple components. If these components are diff --git a/doc/settings/database.md b/doc/settings/database.md index e56e32dcb7b6820db9f6e606d46f90d948d333b4_ZG9jL3NldHRpbmdzL2RhdGFiYXNlLm1k..98e0d2ce836dbb443e7ec7fddf6700a480eee4d3_ZG9jL3NldHRpbmdzL2RhdGFiYXNlLm1k 100644 --- a/doc/settings/database.md +++ b/doc/settings/database.md @@ -8,7 +8,7 @@ Thus you have two options for database servers to use with Omnibus GitLab: -- Use the packaged PostgreSQL server included with GitLab Omnibus (no configuration required, recommended) +- Use the packaged PostgreSQL server included with Omnibus GitLab (no configuration required, recommended) - Use an [external PostgreSQL server](#using-a-non-packaged-postgresql-database-management-server) ## Using the PostgreSQL Database Service shipped with Omnibus GitLab @@ -593,7 +593,7 @@ --- Omnibus GitLab will not automatically seed your external database. Run the -following command to import the schema and create the first admin user: +following command to import the schema and create the first administration user: ```shell # Remove 'sudo' if you are the 'git' user @@ -634,7 +634,7 @@ This `default_transaction_isolation` configuration is set in your `postgresql.conf` file. You will need to restart/reload the database once you changed the configuration. This configuration comes by default in the packaged -PostgreSQL server included with GitLab Omnibus. +PostgreSQL server included with Omnibus GitLab. ## Application Settings for the Database @@ -694,7 +694,7 @@ postgresql['max_replication_slots'] = X ``` - 1. Run `gitlab-ctl reconfigure` to update the configureation. + 1. Run `gitlab-ctl reconfigure` to update the configuration. 1. Run `sudo gitlab-ctl restart postgresql` to get PostgreSQL restarted with the new configuration. 1. On running `pg-upgrade` on a PostgreSQL secondary node, the node will be removed from the cluster. @@ -712,7 +712,7 @@ postgresql['max_replication_slots'] = X ``` - 1. Run `gitlab-ctl reconfigure` to update the configureation. + 1. Run `gitlab-ctl reconfigure` to update the configuration. 1. Run `sudo gitlab-ctl restart postgresql` to get PostgreSQL restarted with the new configuration. 1. On a primary node, `pg-upgrade` will update the existing data to match the new PostgreSQL version. diff --git a/doc/settings/nginx.md b/doc/settings/nginx.md index e56e32dcb7b6820db9f6e606d46f90d948d333b4_ZG9jL3NldHRpbmdzL25naW54Lm1k..98e0d2ce836dbb443e7ec7fddf6700a480eee4d3_ZG9jL3NldHRpbmdzL25naW54Lm1k 100644 --- a/doc/settings/nginx.md +++ b/doc/settings/nginx.md @@ -35,7 +35,7 @@ ### Warning -The NGINX config will tell browsers and clients to only communicate with your +The NGINX configuration will tell browsers and clients to only communicate with your GitLab instance over a secure connection for the next 24 months. By enabling HTTPS you'll need to provide a secure connection to your instance for at least the next 24 months. @@ -103,7 +103,7 @@ ## Redirect `HTTP` requests to `HTTPS` -By default, when you specify an external_url starting with 'https', NGINX will +By default, when you specify an `external_url` starting with 'https', NGINX will no longer listen for unencrypted HTTP traffic on port 80. If you want to redirect all HTTP traffic to HTTPS you can use the `redirect_http_to_https` setting. @@ -116,7 +116,7 @@ ## Change the default port and the SSL certificate locations If you need to use an HTTPS port other than the default (443), just specify it -as part of the external_url. +as part of the `external_url`. ```ruby external_url "https://gitlab.example.com:2443" @@ -221,7 +221,7 @@ Consider removing the offending ciphers from the cipher list. Changing ciphers is only necessary if you have a very specific custom setup. -For more info on why you would want to have http2 protocol enabled, check out +For more information on why you would want to have http2 protocol enabled, check out the [http2 whitepaper]. If changing the ciphers is not an option you can disable http2 support by @@ -409,5 +409,5 @@ - <https://www.w3.org/TR/referrer-policy/> -## Disabling GZIP compression +## Disabling Gzip compression @@ -413,5 +413,5 @@ -By default, GitLab enables GZIP compression for text data over 10240 bytes. To +By default, GitLab enables Gzip compression for text data over 10240 bytes. To disable this behavior: ```ruby @@ -487,9 +487,9 @@ proxy_pass http://gitlab-workhorse; ``` - in the string or in the included NGINX config. Without these, any sub-location + in the string or in the included NGINX configuration. Without these, any sub-location will return a 404. See [GitLab CE Issue #30619](https://gitlab.com/gitlab-org/gitlab-foss/issues/30619). - You cannot add the root `/` location or the `/assets` location as those already exist in `gitlab-http.conf`. @@ -491,7 +491,7 @@ will return a 404. See [GitLab CE Issue #30619](https://gitlab.com/gitlab-org/gitlab-foss/issues/30619). - You cannot add the root `/` location or the `/assets` location as those already exist in `gitlab-http.conf`. -## Inserting custom settings into the NGINX config +## Inserting custom settings into the NGINX configuration @@ -497,5 +497,5 @@ -If you need to add custom settings into the NGINX config, for example to include +If you need to add custom settings into the NGINX configuration, for example to include existing server blocks, you can use the following setting. ```ruby diff --git a/doc/settings/prometheus.md b/doc/settings/prometheus.md index e56e32dcb7b6820db9f6e606d46f90d948d333b4_ZG9jL3NldHRpbmdzL3Byb21ldGhldXMubWQ=..98e0d2ce836dbb443e7ec7fddf6700a480eee4d3_ZG9jL3NldHRpbmdzL3Byb21ldGhldXMubWQ= 100644 --- a/doc/settings/prometheus.md +++ b/doc/settings/prometheus.md @@ -67,7 +67,7 @@ ## Grafana dashboards [Grafana](https://grafana.com) is a powerful dashboard software for presenting -Prometheus metrics data. GitLab Omnibus >= 11.9 includes an embedded copy. +Prometheus metrics data. Omnibus GitLab >= 11.9 includes an embedded copy. See [the embedded Grafana documentation](grafana.md) for more information. diff --git a/doc/settings/redis.md b/doc/settings/redis.md index e56e32dcb7b6820db9f6e606d46f90d948d333b4_ZG9jL3NldHRpbmdzL3JlZGlzLm1k..98e0d2ce836dbb443e7ec7fddf6700a480eee4d3_ZG9jL3NldHRpbmdzL3JlZGlzLm1k 100644 --- a/doc/settings/redis.md +++ b/doc/settings/redis.md @@ -36,7 +36,7 @@ ## Setting up a Redis-only server If you'd like to setup a separate Redis server (e.g. in the case of scaling -issues) for use with GitLab you can do so using GitLab Omnibus. +issues) for use with GitLab you can do so using Omnibus GitLab. ### Setting up the Redis Node @@ -45,7 +45,7 @@ > information. We recommend using a combination of a Redis password and tight > firewall rules to secure your Redis service. -1. Download/install GitLab Omnibus using **steps 1 and 2** from +1. Download/install Omnibus GitLab using **steps 1 and 2** from [GitLab downloads](https://about.gitlab.com/install/). Do not complete other steps on the download page. 1. Create/edit `/etc/gitlab/gitlab.rb` and use the following configuration. @@ -95,7 +95,7 @@ Google Cloud Memorystore [does not support the Redis `CLIENT` command.](https://cloud.google.com/memorystore/docs/reference/redis-configs#blocked) By default Sidekiq will attempt to set the `CLIENT` for debugging -purposes. This can be disabled via this config setting: +purposes. This can be disabled via this configuration setting: ```ruby gitlab_rails['redis_enable_client'] = false @@ -252,7 +252,7 @@ ## Common Troubleshooting -### x509: certificate signed by unknown authority +### `x509: certificate signed by unknown authority` This error message suggests that the SSL certificates have not been properly added to the list of trusted certificates for the server. To diff --git a/doc/settings/ssl.md b/doc/settings/ssl.md index e56e32dcb7b6820db9f6e606d46f90d948d333b4_ZG9jL3NldHRpbmdzL3NzbC5tZA==..98e0d2ce836dbb443e7ec7fddf6700a480eee4d3_ZG9jL3NldHRpbmdzL3NzbC5tZA== 100644 --- a/doc/settings/ssl.md +++ b/doc/settings/ssl.md @@ -176,7 +176,7 @@ 1. `certificate signed by unknown authority` This error indicates that the client does not trust the certificate or CA. To fix this error, the client connecting to server will need to [trust the certificate or CA](#install-custom-public-certificates). - + 1. `SSL certificate problem: self signed certificate in certificate chain` This error indicates that the client does not trust the certificate or CA. To fix this error, the client connecting to server will need to [trust the certificate or CA](#install-custom-public-certificates). @@ -208,7 +208,7 @@ ERROR: Not a certificate: /opt/gitlab/embedded/ssl/certs/FILE. Move it from /opt/gitlab/embedded/ssl/certs to a different location and reconfigure again. ``` -Check `/opt/gitlab/embedded/ssl/certs` and remove any files other than `README.md` that aren't valid x509 certificates. +Check `/opt/gitlab/embedded/ssl/certs` and remove any files other than `README.md` that aren't valid X.509 certificates. NOTE: **Under the Hood** Running `gitlab-ctl reconfigure` constructs symlinks named from the subject hashes