diff options
| author | Douglas Barbosa Alexandre <dbalexandre@gmail.com> | 2019-09-10 17:03:14 -0300 |
|---|---|---|
| committer | Douglas Barbosa Alexandre <dbalexandre@gmail.com> | 2019-09-10 17:03:14 -0300 |
| commit | cfe77ce4a3494b9c1516fe7e915f76b21a68e763 (patch) | |
| tree | cef43c4d6c2fdee57ad19ab6815e41617eace2f2 /doc | |
| parent | 934d4925d85f22c67e7ad57f607e8fe430a9ea92 (diff) | |
| parent | 95d16dc007f3fe8831f2baa511bbb7bd708baff0 (diff) | |
| download | gitlab-ce-cfe77ce4a3494b9c1516fe7e915f76b21a68e763.tar.gz | |
Merge remote-tracking branch 'origin/master' into camilstaps/gitlab-ce-new-66023-public-private-fork-counts
Diffstat (limited to 'doc')
40 files changed, 348 insertions, 160 deletions
diff --git a/doc/administration/index.md b/doc/administration/index.md index d557068e6c8..b58291b7478 100644 --- a/doc/administration/index.md +++ b/doc/administration/index.md @@ -104,6 +104,7 @@ Learn how to install, configure, update, and maintain your GitLab instance. ## User settings and permissions +- [Creating users](../user/profile/account/create_accounts.md): Create users manually or through authentication integrations. - [Libravatar](../customization/libravatar.md): Use Libravatar instead of Gravatar for user avatars. - [Sign-up restrictions](../user/admin_area/settings/sign_up_restrictions.md): block email addresses of specific domains, or whitelist only specific domains. - [Access restrictions](../user/admin_area/settings/visibility_and_access_controls.md#enabled-git-access-protocols): Define which Git access protocols can be used to talk to GitLab (SSH, HTTP, HTTPS). diff --git a/doc/administration/repository_storage_types.md b/doc/administration/repository_storage_types.md index 3ee8673b297..d2d7ebdd634 100644 --- a/doc/administration/repository_storage_types.md +++ b/doc/administration/repository_storage_types.md @@ -10,7 +10,7 @@ that can be: - Mounted to the local disk - Exposed as an NFS shared volume -- Acessed via [gitaly] on its own machine. +- Accessed via [gitaly] on its own machine. In GitLab, this is configured in `/etc/gitlab/gitlab.rb` by the `git_data_dirs({})` configuration hash. The storage layouts discussed here will apply to any shard diff --git a/doc/administration/smime_signing_email.md b/doc/administration/smime_signing_email.md index b2e3bf8487b..530553ec1c4 100644 --- a/doc/administration/smime_signing_email.md +++ b/doc/administration/smime_signing_email.md @@ -11,29 +11,56 @@ S/MIME signs and/or encrypts the message itself ## Enable S/MIME signing This setting must be explicitly enabled and a single pair of key and certificate -files must be provided in `gitlab.rb` or `gitlab.yml` if you are using Omnibus -GitLab or installed GitLab from source respectively: - -```yaml -email_smime: - enabled: true - key_file: /etc/pki/smime/private/gitlab.key - cert_file: /etc/pki/smime/certs/gitlab.crt -``` +files must be provided: -- Both files must be provided PEM-encoded. -- The key file must be unencrypted so that Gitlab can read it without user +- Both files must be PEM-encoded. +- The key file must be unencrypted so that GitLab can read it without user intervention. +- Only RSA keys are supported. NOTE: **Note:** Be mindful of the access levels for your private keys and visibility to third parties. +**For Omnibus installations:** + +1. Edit `/etc/gitlab/gitlab.rb` and adapt the file paths: + + ```ruby + gitlab_rails['gitlab_email_smime_enabled'] = true + gitlab_rails['gitlab_email_smime_key_file'] = '/etc/gitlab/ssl/gitlab_smime.key' + gitlab_rails['gitlab_email_smime_cert_file'] = '/etc/gitlab/ssl/gitlab_smime.crt' + ``` + +1. Save the file and [reconfigure GitLab](restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. + +NOTE: **Note:** The key needs to be readable by the GitLab system user (`git` by default). + +**For installations from source:** + +1. Edit `config/gitlab.yml`: + + ```yaml + email_smime: + # Uncomment and set to true if you need to enable email S/MIME signing (default: false) + enabled: true + # S/MIME private key file in PEM format, unencrypted + # Default is '.gitlab_smime_key' relative to Rails.root (i.e. root of the GitLab app). + key_file: /etc/pki/smime/private/gitlab.key + # S/MIME public certificate key in PEM format, will be attached to signed messages + # Default is '.gitlab_smime_cert' relative to Rails.root (i.e. root of the GitLab app). + cert_file: /etc/pki/smime/certs/gitlab.crt + ``` + +1. Save the file and [restart GitLab](restart_gitlab.md#installations-from-source) for the changes to take effect. + +NOTE: **Note:** The key needs to be readable by the GitLab system user (`git` by default). + ### How to convert S/MIME PKCS#12 / PFX format to PEM encoding Typically S/MIME certificates are handled in binary PKCS#12 format (`.pfx` or `.p12` extensions), which contain the following in a single encrypted file: -- Server certificate +- Public certificate - Intermediate certificates (if any) - Private key diff --git a/doc/administration/troubleshooting/sidekiq.md b/doc/administration/troubleshooting/sidekiq.md index c41edb5dbfc..fdafac8420e 100644 --- a/doc/administration/troubleshooting/sidekiq.md +++ b/doc/administration/troubleshooting/sidekiq.md @@ -270,7 +270,7 @@ is interrupted mid-execution and it is not guaranteed that proper rollback of transactions is implemented. ```ruby -Gitlab::SidekiqMonitor.cancel_job('job-id') +Gitlab::SidekiqDaemon::Monitor.cancel_job('job-id') ``` > This requires the Sidekiq to be run with `SIDEKIQ_MONITOR_WORKER=1` diff --git a/doc/api/projects.md b/doc/api/projects.md index cf28ea84704..3ea1434d5ca 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -929,7 +929,7 @@ POST /projects | `ci_config_path` | string | no | The path to CI config file | | `auto_devops_enabled` | boolean | no | Enable Auto DevOps for this project | | `auto_devops_deploy_strategy` | string | no | Auto Deploy strategy (`continuous`, `manual` or `timed_incremental`) | -| `repository_storage` | string | no | Which storage shard the repository is on. Available only to admins | +| `repository_storage` | string | no | **(STARTER ONLY)** Which storage shard the repository is on. Available only to admins | | `approvals_before_merge` | integer | no | **(STARTER)** How many approvers should approve merge requests by default | | `mirror` | boolean | no | **(STARTER)** Enables pull mirroring in a project | | `mirror_trigger_builds` | boolean | no | **(STARTER)** Pull mirroring triggers builds | @@ -986,7 +986,7 @@ POST /projects/user/:user_id | `ci_config_path` | string | no | The path to CI config file | | `auto_devops_enabled` | boolean | no | Enable Auto DevOps for this project | | `auto_devops_deploy_strategy` | string | no | Auto Deploy strategy (`continuous`, `manual` or `timed_incremental`) | -| `repository_storage` | string | no | Which storage shard the repository is on. Available only to admins | +| `repository_storage` | string | no | **(STARTER ONLY)** Which storage shard the repository is on. Available only to admins | | `approvals_before_merge` | integer | no | **(STARTER)** How many approvers should approve merge requests by default | | `external_authorization_classification_label` | string | no | **(PREMIUM)** The classification label for the project | | `mirror` | boolean | no | **(STARTER)** Enables pull mirroring in a project | @@ -1043,7 +1043,7 @@ PUT /projects/:id | `ci_default_git_depth` | integer | no | Default number of revisions for [shallow cloning](../user/project/pipelines/settings.md#git-shallow-clone) | | `auto_devops_enabled` | boolean | no | Enable Auto DevOps for this project | | `auto_devops_deploy_strategy` | string | no | Auto Deploy strategy (`continuous`, `manual` or `timed_incremental`) | -| `repository_storage` | string | no | Which storage shard the repository is on. Available only to admins | +| `repository_storage` | string | no | **(STARTER ONLY)** Which storage shard the repository is on. Available only to admins | | `approvals_before_merge` | integer | no | **(STARTER)** How many approvers should approve merge request by default | | `external_authorization_classification_label` | string | no | **(PREMIUM)** The classification label for the project | | `mirror` | boolean | no | **(STARTER)** Enables pull mirroring in a project | diff --git a/doc/api/tags.md b/doc/api/tags.md index 1d874fea1f8..88f63d6b34b 100644 --- a/doc/api/tags.md +++ b/doc/api/tags.md @@ -46,7 +46,8 @@ Parameters: }, "name": "v1.0.0", "target": "2695effb5807a22ff3d138d593fd856244e155e7", - "message": null + "message": null, + "protected": true } ] ``` @@ -94,7 +95,8 @@ Example Response: "committer_email": "contact@arthurverschaeve.be", "committed_date": "2015-02-01T21:56:31.000+01:00" }, - "release": null + "release": null, + "protected": false } ``` @@ -138,7 +140,8 @@ Parameters: }, "name": "v1.0.0", "target": "2695effb5807a22ff3d138d593fd856244e155e7", - "message": null + "message": null, + "protected": false } ``` diff --git a/doc/ci/variables/predefined_variables.md b/doc/ci/variables/predefined_variables.md index 409f7d62538..a3c253cc517 100644 --- a/doc/ci/variables/predefined_variables.md +++ b/doc/ci/variables/predefined_variables.md @@ -100,6 +100,7 @@ future GitLab releases.** | `CI_RUNNER_REVISION` | all | 10.6 | GitLab Runner revision that is executing the current job | | `CI_RUNNER_TAGS` | 8.10 | 0.5 | The defined runner tags | | `CI_RUNNER_VERSION` | all | 10.6 | GitLab Runner version that is executing the current job | +| `CI_RUNNER_SHORT_TOKEN` | all | 12.3 | First eight characters of GitLab Runner's token used to authenticate new job requests. Used as Runner's unique ID | | `CI_SERVER` | all | all | Mark that job is executed in CI environment | | `CI_SERVER_HOST` | 12.1 | all | Host component of the GitLab instance URL, without protocol and port (like gitlab.example.com) | | `CI_SERVER_NAME` | all | all | The name of CI server that is used to coordinate jobs | diff --git a/doc/development/changelog.md b/doc/development/changelog.md index 814624c7586..5667f58b0c3 100644 --- a/doc/development/changelog.md +++ b/doc/development/changelog.md @@ -99,7 +99,7 @@ automatically. Its simplest usage is to provide the value for `title`: ```text -$ bin/changelog 'Hey DZ, I added a feature to GitLab!' +bin/changelog 'Hey DZ, I added a feature to GitLab!' ``` At this point the script would ask you to select the category of the change (mapped to the `type` field in the entry): diff --git a/doc/development/code_review.md b/doc/development/code_review.md index bcfc0734c06..0afa44a5491 100644 --- a/doc/development/code_review.md +++ b/doc/development/code_review.md @@ -72,7 +72,7 @@ from teams other than your own. 1. If your merge request includes adding a new UI/UX paradigm [^1], it must be **approved by a [UX lead][team]**. 1. If your merge request includes a new dependency or a filesystem change, it must be - **approved by a [Distribution team member][team]**. See how to work with the [Distribution team](https://about.gitlab.com/handbook/engineering/dev-backend/distribution/) for more details. + **approved by a [Distribution team member][team]**. See how to work with the [Distribution team](https://about.gitlab.com/handbook/engineering/development/enablement/distribution/#how-to-work-with-distribution) for more details. #### Security requirements diff --git a/doc/development/distributed_tracing.md b/doc/development/distributed_tracing.md index 4776c8348d4..d2810fe89f0 100644 --- a/doc/development/distributed_tracing.md +++ b/doc/development/distributed_tracing.md @@ -27,7 +27,7 @@ no overhead at all. To enable `GITLAB_TRACING`, a valid _"configuration-string"_ value should be set, with a URL-like form: -```console +```sh GITLAB_TRACING=opentracing://<driver>?<param_name>=<param_value>&<param_name_2>=<param_value_2> ``` @@ -90,7 +90,7 @@ documentation](https://www.jaegertracing.io/docs/1.9/getting-started/). If you have Docker available, the easier approach to running the Jaeger all-in-one is through Docker, using the following command: -```console +```sh $ docker run \ --rm \ -e COLLECTOR_ZIPKIN_HTTP_PORT=9411 \ @@ -121,8 +121,8 @@ appropriate configuration string. **TL;DR:** If you are running everything on the same host, use the following value: -```console -$ export GITLAB_TRACING="opentracing://jaeger?http_endpoint=http%3A%2F%2Flocalhost%3A14268%2Fapi%2Ftraces&sampler=const&sampler_param=1" +```sh +export GITLAB_TRACING="opentracing://jaeger?http_endpoint=http%3A%2F%2Flocalhost%3A14268%2Fapi%2Ftraces&sampler=const&sampler_param=1" ``` This configuration string uses the Jaeger driver `opentracing://jaeger` with the following options: @@ -152,7 +152,7 @@ application. When `GITLAB_TRACING` is configured properly, the application will log this on startup: -```console +```sh 13:41:53 gitlab-workhorse.1 | 2019/02/12 13:41:53 Tracing enabled ... 13:41:54 gitaly.1 | 2019/02/12 13:41:54 Tracing enabled @@ -161,7 +161,7 @@ When `GITLAB_TRACING` is configured properly, the application will log this on s If `GITLAB_TRACING` is not configured correctly, this will also be logged: -```console +```sh 13:43:45 gitaly.1 | 2019/02/12 13:43:45 skipping tracing configuration step: tracer: unable to load driver mytracer ``` diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index 4a50e90a26c..39b5e191a7b 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -262,7 +262,7 @@ table_display_block: true ## Punctuation Check the general punctuation rules for the GitLab documentation on the table below. -Check specific punctuation rules for [list items](#list-items) below. +Check specific punctuation rules for [lists](#lists) below. | Rule | Example | | ---- | ------- | @@ -274,37 +274,44 @@ Check specific punctuation rules for [list items](#list-items) below. | Always add a space before and after dashes when using it in a sentence (for replacing a comma, for example). | _You should try this - or not._ | | Always use lowercase after a colon. | _Related Issues: a way to create a relationship between issues._ | -## List items +## Lists - Always start list items with a capital letter, unless they are parameters or commands that are in backticks, or similar. - Always leave a blank line before and after a list. - Begin a line with spaces (not tabs) to denote a [nested subitem](#nesting-inside-a-list-item). -- Only use ordered lists when their items describe a sequence of steps to follow: - Do: +### Ordered vs. unordered lists - These are the steps to do something: +Only use ordered lists when their items describe a sequence of steps to follow. - 1. First, do step 1 - 1. Then, do step 2 - 1. Finally, do step 3 +Do: + +```md +These are the steps to do something: + +1. First, do the first step. +1. Then, do the next step. +1. Finally, do the last step. +``` - Don't: +Don't: - This is a list of different features: +```md +This is a list of available features: - 1. Feature 1 - 1. Feature 2 - 1. Feature 3 +1. Feature 1 +1. Feature 2 +1. Feature 3 +``` -**Markup:** +### Markup - Use dashes (`-`) for unordered lists instead of asterisks (`*`). -- Prefix `1.` to each item in an ordered list. +- Prefix `1.` to every item in an ordered list. When rendered, the list items will appear with sequential numbering automatically. -**Punctuation:** +### Punctuation - Do not add commas (`,`) or semicolons (`;`) to the end of list items. - Only add periods to the end of a list item if the item consists of a complete sentence. @@ -343,7 +350,7 @@ Do: - Let's say this is also a complete sentence. - Not a complete sentence. -Don't (third item should have a `.` to match the first and second items): +Don't (vary use of periods; majority rules): - Let's say this is a complete sentence. - Let's say this is also a complete sentence. diff --git a/doc/development/fe_guide/vuex.md b/doc/development/fe_guide/vuex.md index 557d3132d71..336ef4ab278 100644 --- a/doc/development/fe_guide/vuex.md +++ b/doc/development/fe_guide/vuex.md @@ -13,7 +13,7 @@ _Note:_ The action itself will not update the state, only a mutation should upda ## File structure -When using Vuex at GitLab, separate this concerns into different files to improve readability: +When using Vuex at GitLab, separate these concerns into different files to improve readability: ``` └── store diff --git a/doc/development/instrumentation.md b/doc/development/instrumentation.md index 777d372ec60..b22a63621dc 100644 --- a/doc/development/instrumentation.md +++ b/doc/development/instrumentation.md @@ -81,9 +81,7 @@ If you're using Pry you can use the `$` command to display the source code of a method (along with its source location), this is easier than running the above Ruby code. In case of the above snippet you'd run the following: -``` -$ Banzai::Renderer.render -``` +- `$ Banzai::Renderer.render` This will print out something along the lines of: diff --git a/doc/development/performance.md b/doc/development/performance.md index 14b3f8204d2..6e6c80b7a7c 100644 --- a/doc/development/performance.md +++ b/doc/development/performance.md @@ -123,7 +123,7 @@ Keeping that in mind, to create a profile, identify (or create) a spec that exercises the troublesome code path, then run it using the `bin/rspec-stackprof` helper, e.g.: -``` +```sh $ LIMIT=10 bin/rspec-stackprof spec/policies/project_policy_spec.rb 8/8 |====== 100 ======>| Time: 00:00:18 @@ -157,22 +157,22 @@ it calls, were being executed. To create a graphical view of the call stack: -```shell -$ stackprof tmp/project_policy_spec.rb.dump --graphviz > project_policy_spec.dot -$ dot -Tsvg project_policy_spec.dot > project_policy_spec.svg +```sh +stackprof tmp/project_policy_spec.rb.dump --graphviz > project_policy_spec.dot +dot -Tsvg project_policy_spec.dot > project_policy_spec.svg ``` To load the profile in [kcachegrind](https://kcachegrind.github.io/): -``` -$ stackprof tmp/project_policy_spec.dump --callgrind > project_policy_spec.callgrind -$ kcachegrind project_policy_spec.callgrind # Linux -$ qcachegrind project_policy_spec.callgrind # Mac +```sh +stackprof tmp/project_policy_spec.dump --callgrind > project_policy_spec.callgrind +kcachegrind project_policy_spec.callgrind # Linux +qcachegrind project_policy_spec.callgrind # Mac ``` It may be useful to zoom in on a specific method, e.g.: -``` +```sh $ stackprof tmp/project_policy_spec.rb.dump --method warm_asset_cache TestEnv#warm_asset_cache (/Users/lupine/dev/gitlab.com/gitlab-org/gitlab-development-kit/gitlab/spec/support/test_env.rb:164) samples: 0 self (0.0%) / 6288 total (36.9%) @@ -225,9 +225,9 @@ may have changed over time. To activate profiling in your local environment, run the following: -``` -$ export RSPEC_PROFILING=yes -$ rake rspec_profiling:install +```sh +export RSPEC_PROFILING=yes +rake rspec_profiling:install ``` This creates an SQLite3 database in `tmp/rspec_profiling`, into which statistics @@ -237,7 +237,7 @@ variable set. Ad-hoc investigation of the collected results can be performed in an interactive shell: -``` +```sh $ rake rspec_profiling:console irb(main):001:0> results.count => 231 diff --git a/doc/development/testing_guide/frontend_testing.md b/doc/development/testing_guide/frontend_testing.md index 7dc89a3fcdb..91004bf177d 100644 --- a/doc/development/testing_guide/frontend_testing.md +++ b/doc/development/testing_guide/frontend_testing.md @@ -20,9 +20,18 @@ We have started to migrate frontend tests to the [Jest](https://jestjs.io) testi Jest tests can be found in `/spec/frontend` and `/ee/spec/frontend` in EE. -It is not yet a requirement to use Jest. You can view the -[epic](https://gitlab.com/groups/gitlab-org/-/epics/873) of issues -we need to solve before being able to use Jest for all our needs. +### When should I use Jest over Karma? + +If you need to update an existing Karma test file (found in `spec/javascripts`), you do not +need to migrate the whole spec to Jest. Simply updating the Karma spec to test your change +is fine. It is probably more appropriate to migrate to Jest in a separate merge request. + +If you need to create a new test file, we strongly recommend creating one in Jest. This will +help support our migration and we think you'll love using Jest. + +As always, please use discretion. Jest solves a lot of issues we experienced in Karma and +provides a better developer experience, however there are potentially unexpected issues +which could arise (especially with testing against browser specific features). ### Differences to Karma diff --git a/doc/downgrade_ee_to_ce/README.md b/doc/downgrade_ee_to_ce/README.md index a3f6f2b327c..0dc029a4cd1 100644 --- a/doc/downgrade_ee_to_ce/README.md +++ b/doc/downgrade_ee_to_ce/README.md @@ -47,14 +47,14 @@ to avoid getting this error, you need to remove all instances of the **Omnibus Installation** -``` -$ sudo gitlab-rails runner "Service.where(type: ['JenkinsService', 'JenkinsDeprecatedService', 'GithubService']).delete_all" +```sh +sudo gitlab-rails runner "Service.where(type: ['JenkinsService', 'JenkinsDeprecatedService', 'GithubService']).delete_all" ``` **Source Installation** -``` -$ bundle exec rails runner "Service.where(type: ['JenkinsService', 'JenkinsDeprecatedService', 'GithubService']).delete_all" production +```sh +bundle exec rails runner "Service.where(type: ['JenkinsService', 'JenkinsDeprecatedService', 'GithubService']).delete_all" production ``` ### Variables environment scopes @@ -89,10 +89,10 @@ To downgrade a source installation, you need to replace the current remote of your GitLab installation with the Community Edition's remote, fetch the latest changes, and checkout the latest stable branch: -``` -$ git remote set-url origin git@gitlab.com:gitlab-org/gitlab-ce.git -$ git fetch --all -$ git checkout 8-x-stable +```sh +git remote set-url origin git@gitlab.com:gitlab-org/gitlab-ce.git +git fetch --all +git checkout 8-x-stable ``` Remember to follow the correct [update guides](../update/README.md) to make diff --git a/doc/install/aws/index.md b/doc/install/aws/index.md index 358ba971049..ddf2b2fb738 100644 --- a/doc/install/aws/index.md +++ b/doc/install/aws/index.md @@ -613,6 +613,9 @@ To back up GitLab: sudo gitlab-backup create ``` +NOTE: **Note** +For GitLab 12.1 and earlier, use `gitlab-rake gitlab:backup:create`. + ### Restoring GitLab from a backup To restore GitLab, first review the [restore documentation](../../raketasks/backup_restore.md#restore), @@ -631,6 +634,9 @@ released, you can update your GitLab instance: sudo gitlab-backup create ``` +NOTE: **Note** +For GitLab 12.1 and earlier, use `gitlab-rake gitlab:backup:create`. + 1. Update the repositories and install GitLab: ```sh diff --git a/doc/install/openshift_and_gitlab/index.md b/doc/install/openshift_and_gitlab/index.md index fbbe2a34952..cfd0fd48c70 100644 --- a/doc/install/openshift_and_gitlab/index.md +++ b/doc/install/openshift_and_gitlab/index.md @@ -225,7 +225,7 @@ First, we will create a new project to host our application. You can do this either by running the CLI client: ```bash -$ oc new-project gitlab +oc new-project gitlab ``` or by using the web interface: diff --git a/doc/integration/github.md b/doc/integration/github.md index f19b3109d15..23dd67f6891 100644 --- a/doc/integration/github.md +++ b/doc/integration/github.md @@ -158,7 +158,7 @@ For installation from source: You will also need to disable Git SSL verification on the server hosting GitLab. ``` -$ git config --global http.sslVerify false +git config --global http.sslVerify false ``` For the changes to take effect, [reconfigure GitLab] if you installed diff --git a/doc/migrate_ci_to_ce/README.md b/doc/migrate_ci_to_ce/README.md index 50e491f29a2..4a96001f2de 100644 --- a/doc/migrate_ci_to_ce/README.md +++ b/doc/migrate_ci_to_ce/README.md @@ -77,6 +77,9 @@ sudo -u git -H bundle exec rake gitlab:backup:create RAILS_ENV=production SKIP=r If this fails you need to fix it before upgrading to 8.0. Also see <https://about.gitlab.com/get-help/> +NOTE: **Note** +For GitLab 12.1 and earlier, use `gitlab-rake gitlab:backup:create`. + ### 2. Check source and target database types Check what databases you use on your GitLab server and your CI server. diff --git a/doc/raketasks/backup_restore.md b/doc/raketasks/backup_restore.md index 06048ad618f..c230bb413f2 100644 --- a/doc/raketasks/backup_restore.md +++ b/doc/raketasks/backup_restore.md @@ -80,6 +80,9 @@ Use this command if you've installed GitLab with the Omnibus package: sudo gitlab-backup create ``` +NOTE: **Note** +For GitLab 12.1 and earlier, use `gitlab-rake gitlab:backup:create`. + Use this if you've installed GitLab from source: ```sh @@ -92,6 +95,9 @@ If you are running GitLab within a Docker container, you can run the backup from docker exec -t <container name> gitlab-backup create ``` +NOTE: **Note** +For GitLab 12.1 and earlier, use `gitlab-rake gitlab:backup:create`. + If you are using the [GitLab helm chart](https://gitlab.com/gitlab-org/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/gitlab-org/charts/gitlab/blob/master/doc/backup-restore/backup.md#backing-up-a-gitlab-installation) for more details: @@ -202,6 +208,9 @@ To use the `copy` strategy instead of the default streaming strategy, specify sudo gitlab-backup create STRATEGY=copy ``` +NOTE: **Note** +For GitLab 12.1 and earlier, use `gitlab-rake gitlab:backup:create`. + ### Backup filename By default a backup file is created according to the specification in [the Backup timestamp](#backup-timestamp) section above. You can however override the `[TIMESTAMP]` part of the filename by setting the `BACKUP` environment variable. For example: @@ -210,6 +219,9 @@ By default a backup file is created according to the specification in [the Backu sudo gitlab-backup create BACKUP=dump ``` +NOTE: **Note** +For GitLab 12.1 and earlier, use `gitlab-rake gitlab:backup:create`. + The resulting file will then be `dump_gitlab_backup.tar`. This is useful for systems that make use of rsync and incremental backups, and will result in considerably faster transfer speeds. ### Rsyncable @@ -222,6 +234,9 @@ Note that the `--rsyncable` option in `gzip` is not guaranteed to be available o sudo gitlab-backup create BACKUP=dump GZIP_RSYNCABLE=yes ``` +NOTE: **Note** +For GitLab 12.1 and earlier, use `gitlab-rake gitlab:backup:create`. + ### Excluding specific directories from the backup You can choose what should be exempt from the backup up by adding the environment variable `SKIP`. @@ -247,6 +262,9 @@ For Omnibus GitLab packages: sudo gitlab-backup create SKIP=db,uploads ``` +NOTE: **Note** +For GitLab 12.1 and earlier, use `gitlab-rake gitlab:backup:create`. + For installations from source: ```sh @@ -452,6 +470,9 @@ sudo gitlab-backup create DIRECTORY=daily sudo gitlab-backup create DIRECTORY=weekly ``` +NOTE: **Note** +For GitLab 12.1 and earlier, use `gitlab-rake gitlab:backup:create`. + ### Uploading to locally mounted shares You may also send backups to a mounted share (`NFS` / `CIFS` / `SMB` / etc.) by @@ -569,6 +590,9 @@ There, add the following line to schedule the backup for everyday at 2 AM: 0 2 * * * /opt/gitlab/bin/gitlab-backup create CRON=1 ``` +NOTE: **Note** +For GitLab 12.1 and earlier, use `gitlab-rake gitlab:backup:create`. + You may also want to set a limited lifetime for backups to prevent regular backups using all your disk space. @@ -729,6 +753,14 @@ restore: sudo gitlab-backup restore BACKUP=1493107454_2018_04_25_10.6.4-ce ``` +NOTE: **Note** +For GitLab 12.1 and earlier, use `gitlab-rake gitlab:backup:restore`. + +CAUTION: **Warning:** +`gitlab-rake gitlab:backup:restore` does not set the right file system permissions on your Registry directory. +This is a [known issue](https://gitlab.com/gitlab-org/gitlab-ce/issues/62759). On GitLab 12.2 or newer, you can +use `gitlab-backup restore` to avoid this issue. + Next, restore `/etc/gitlab/gitlab-secrets.json` if necessary as mentioned above. Reconfigure, restart and check GitLab: @@ -763,6 +795,14 @@ For docker installations, the restore task can be run from host: docker exec -it <name of container> gitlab-backup restore ``` +NOTE: **Note** +For GitLab 12.1 and earlier, use `gitlab-rake gitlab:backup:restore`. + +CAUTION: **Warning:** +`gitlab-rake gitlab:backup:restore` does not set the right file system permissions on your Registry directory. +This is a [known issue](https://gitlab.com/gitlab-org/gitlab-ce/issues/62759). On GitLab 12.2 or newer, you can +use `gitlab-backup restore` to avoid this issue. + The GitLab helm chart uses a different process, documented in [restoring a GitLab helm chart installation](https://gitlab.com/gitlab-org/charts/gitlab/blob/master/doc/backup-restore/restore.md). @@ -978,7 +1018,7 @@ sudo chown -R registry:registry /var/opt/gitlab/gitlab-rails/shared/registry/doc NOTE: **Note:** If you have changed the default filesystem location for the registry, you will -want to run the chown against your custom location instead of +want to run the `chown` against your custom location instead of `/var/opt/gitlab/gitlab-rails/shared/registry/docker`. [reconfigure GitLab]: ../administration/restart_gitlab.md#omnibus-gitlab-reconfigure @@ -990,6 +1030,7 @@ While running the backup, you may receive a gzip error: ```sh sudo /opt/gitlab/bin/gitlab-backup create +... Dumping ... ... gzip: stdout: Input/output error @@ -999,5 +1040,5 @@ Backup failed If this happens, check the following: -1. Confirm there is sufficent diskspace for the gzip operation. -1. If NFS is being used, check if the mount option `timeo` is set. The default is `600`, and changing this to smaller values have resulted in this error. +1. Confirm there is sufficient disk space for the gzip operation. +1. If NFS is being used, check if the mount option `timeout` is set. The default is `600`, and changing this to smaller values have resulted in this error. diff --git a/doc/raketasks/import.md b/doc/raketasks/import.md index d93e7241fda..326f7e4b982 100644 --- a/doc/raketasks/import.md +++ b/doc/raketasks/import.md @@ -42,17 +42,17 @@ If you are using an installation from source, replace `/var/opt/gitlab/` with `/ #### Omnibus Installation -``` -$ sudo gitlab-rake gitlab:import:repos['/var/opt/gitlab/git-data/repository-import-<date>'] +```sh +sudo gitlab-rake gitlab:import:repos['/var/opt/gitlab/git-data/repository-import-<date>'] ``` #### Installation from source Before running this command you need to change the directory to where your GitLab installation is located: -``` -$ cd /home/git/gitlab -$ sudo -u git -H bundle exec rake gitlab:import:repos['/var/opt/gitlab/git-data/repository-import-<date>'] RAILS_ENV=production +```sh +cd /home/git/gitlab +sudo -u git -H bundle exec rake gitlab:import:repos['/var/opt/gitlab/git-data/repository-import-<date>'] RAILS_ENV=production ``` #### Example output diff --git a/doc/security/asset_proxy.md b/doc/security/asset_proxy.md index 6a2341c28c8..b480905339b 100644 --- a/doc/security/asset_proxy.md +++ b/doc/security/asset_proxy.md @@ -1,28 +1,68 @@ +# Proxying assets + A possible security concern when managing a public facing GitLab instance is the ability to steal a users IP address by referencing images in issues, comments, etc. For example, adding `` to an issue description will cause the image to be loaded from the external -server in order to be displayed. However this also allows the external server +server in order to be displayed. However, this also allows the external server to log the IP address of the user. One way to mitigate this is by proxying any external images to a server you -control. GitLab handles this by allowing you to run the "Camo" server -[cactus/go-camo](https://github.com/cactus/go-camo#how-it-works). -The image request is sent to the Camo server, which then makes the request for -the original image. This way an attacker only ever seems the IP address -of your Camo server. +control. + +GitLab can be configured to use an asset proxy server when requesting external images/videos in +issues, comments, etc. This helps ensure that malicious images do not expose the user's IP address +when they are fetched. + +We currently recommend using [cactus/go-camo](https://github.com/cactus/go-camo#how-it-works) +as it supports proxying video and is more configurable. + +## Installing Camo server + +A Camo server is used to act as the proxy. + +To install a Camo server as an asset proxy: + +1. Deploy a `go-camo` server. Helpful instructions can be found in + [building catus/go-camo](https://github.com/cactus/go-camo#building). + +1. Make sure your instance of GitLab is running, and that you have created a private API token. + Using the API, configure the asset proxy settings on your GitLab instance. For example: + + ```sh + curl --request "PUT" "https://gitlab.example.com/api/v4/application/settings?\ + asset_proxy_enabled=true&\ + asset_proxy_url=https://proxy.gitlab.example.com&\ + asset_proxy_secret_key=<somekey>" \ + --header 'PRIVATE-TOKEN: <my_private_token>' + ``` + + The following settings are supported: + + | Attribute | Description | + |:-------------------------|:-------------------------------------------------------------------------------------------------------------------------------------| + | `asset_proxy_enabled` | Enable proxying of assets. If enabled, requires: `asset_proxy_url`). | + | `asset_proxy_secret_key` | Shared secret with the asset proxy server. | + | `asset_proxy_url` | URL of the asset proxy server. | + | `asset_proxy_whitelist` | Assets that match these domain(s) will NOT be proxied. Wildcards allowed. Your GitLab installation URL is automatically whitelisted. | + +1. Restart the server for the changes to take effect. Each time you change any values for the asset + proxy, you need to restart the server. + +## Using the Camo server + +Once the Camo server is running and you've enabled the GitLab settings, any image or video that +references an external source will get proxied to the Camo server. -Once you have your Camo server up and running, you can configure GitLab to -proxy image requests to it. The following settings are supported: +For example, the following is a link to an image in Markdown: -| Attribute | Description | -| ------------------------- | ----------- | -| `asset_proxy_enabled` | (**If enabled, requires:** `asset_proxy_url`) Enable proxying of assets. | -| `asset_proxy_secret_key` | Shared secret with the asset proxy server. | -| `asset_proxy_url` | URL of the asset proxy server. | -| `asset_proxy_whitelist` | Assets that match these domain(s) will NOT be proxied. Wildcards allowed. Your GitLab installation URL is automatically whitelisted. | +```markdown + +``` -These can be set via the [Application setting API](../api/settings.md) +The following is an example of a source link that could result: -Note that a GitLab restart is required to apply any changes. +```text +http://proxy.gitlab.example.com/f9dd2b40157757eb82afeedbf1290ffb67a3aeeb/68747470733a2f2f61626f75742e6769746c61622e636f6d2f696d616765732f70726573732f6c6f676f2f6a70672f6769746c61622d69636f6e2d7267622e6a7067 +``` diff --git a/doc/user/application_security/dependency_scanning/index.md b/doc/user/application_security/dependency_scanning/index.md index 89526c08e7e..166a71b6fbe 100644 --- a/doc/user/application_security/dependency_scanning/index.md +++ b/doc/user/application_security/dependency_scanning/index.md @@ -4,8 +4,11 @@ type: reference, howto # Dependency Scanning **(ULTIMATE)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/5105) -in [GitLab Ultimate](https://about.gitlab.com/pricing/) 10.7. +> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/5105) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 10.7. + +Dependency Scanning helps to automatically find security vulnerabilities in your dependencies +while you are developing and testing your applications, for example when your +application is using an external (open source) library which is known to be vulnerable. ## Overview @@ -18,7 +21,7 @@ in your existing `.gitlab-ci.yml` file or by implicitly using that is provided by [Auto DevOps](../../../topics/autodevops/index.md). GitLab checks the Dependency Scanning report, compares the found vulnerabilities -between the source and target branches, and shows the information right on the +between the source and target branches, and shows the information on the merge request.  @@ -32,12 +35,6 @@ The results are sorted by the severity of the vulnerability: 1. Unknown 1. Everything else -## Use cases - -It helps to automatically find security vulnerabilities in your dependencies -while you are developing and testing your applications. For example when your -application is using an external (open source) library which is known to be vulnerable. - ## Requirements To run a Dependency Scanning job, you need GitLab Runner with the @@ -146,7 +143,7 @@ Dependency Scanning can be [configured](#customizing-the-dependency-scanning-set using environment variables. | Environment variable | Description | Example usage | -|-------------------------------- |-------------| | +| --------------------------------------- | ----------- | ------------- | | `DS_ANALYZER_IMAGES` | Comma separated list of custom images. The official default images are still enabled. Read more about [customizing analyzers](analyzers.md). | | | `DS_ANALYZER_IMAGE_PREFIX` | Override the name of the Docker registry providing the official default images (proxy). Read more about [customizing analyzers](analyzers.md). | | | `DS_ANALYZER_IMAGE_TAG` | Override the Docker tag of the official default images. Read more about [customizing analyzers](analyzers.md). | | @@ -162,10 +159,39 @@ using environment variables. | `PIP_INDEX_URL` | Base URL of Python Package Index (default `https://pypi.org/simple`). | | | `PIP_EXTRA_INDEX_URL` | Array of [extra URLs](https://pip.pypa.io/en/stable/reference/pip_install/#cmdoption-extra-index-url) of package indexes to use in addition to `PIP_INDEX_URL`. Comma separated. | | +## Interacting with the vulnerabilities + +Once a vulnerability is found, you can interact with it. Read more on how to +[interact with the vulnerabilities](../index.md#interacting-with-the-vulnerabilities). + +## Solutions for vulnerabilities (auto-remediation) + +Some vulnerabilities can be fixed by applying the solution that GitLab +automatically generates. + +Read more about the [solutions for vulnerabilities](../index.md#solutions-for-vulnerabilities-auto-remediation). + +## Security Dashboard + +The Security Dashboard is a good place to get an overview of all the security +vulnerabilities in your groups, projects and pipelines. Read more about the +[Security Dashboard](../security_dashboard/index.md). + +## Vulnerabilities database update + +For more information about the vulnerabilities database update, check the +[maintenance table](../index.md#maintenance-and-update-of-the-vulnerabilities-database). + +## Dependency List + +An additional benefit of Dependency Scanning is the ability to view your +project's dependencies and their known vulnerabilities. Read more about +the [Dependency List](../dependency_list/index.md). + ## Reports JSON format CAUTION: **Caution:** -The JSON report artifacts are not a public API of Dependency Scanning and their format may change in future. +The JSON report artifacts are not a public API of Dependency Scanning and their format may change in the future. The Dependency Scanning tool emits a JSON report file. Here is an example of the report structure with all important parts of it highlighted: @@ -315,28 +341,6 @@ the report JSON unless stated otherwise. Presence of optional fields depends on | `remediations[].summary` | Overview of how the vulnerabilities have been fixed. | | `remediations[].diff` | base64-encoded remediation code diff, compatible with [`git apply`](https://git-scm.com/docs/git-format-patch#_discussion). | -## Security Dashboard - -The Security Dashboard is a good place to get an overview of all the security -vulnerabilities in your groups, projects and pipelines. Read more about the -[Security Dashboard](../security_dashboard/index.md). - -## Interacting with the vulnerabilities - -Once a vulnerability is found, you can interact with it. Read more on how to -[interact with the vulnerabilities](../index.md#interacting-with-the-vulnerabilities). - -## Vulnerabilities database update - -For more information about the vulnerabilities database update, check the -[maintenance table](../index.md#maintenance-and-update-of-the-vulnerabilities-database). - -## Dependency List **(ULTIMATE)** - -An additional benefit of Dependency Scanning is the ability to view your -project's dependencies and their known vulnerabilities. Read more about -the [Dependency List](../dependency_list/index.md). - ## Versioning and release process Please check the [Release Process documentation](https://gitlab.com/gitlab-org/security-products/release/blob/master/docs/release_process.md). diff --git a/doc/user/application_security/index.md b/doc/user/application_security/index.md index 69529d7420b..f25d792cb90 100644 --- a/doc/user/application_security/index.md +++ b/doc/user/application_security/index.md @@ -71,8 +71,7 @@ entry, a detailed information will pop up with different possible options: - [Create issue](#creating-an-issue-for-a-vulnerability): The new issue will have the title and description pre-populated with the information from the vulnerability report and will be created as [confidential](../project/issues/confidential_issues.md) by default. -- [Solution](#solutions-for-vulnerabilities): For some vulnerabilities - ([Dependency Scanning](dependency_scanning/index.md) and [Container Scanning](container_scanning/index.md)) +- [Solution](#solutions-for-vulnerabilities-auto-remediation): For some vulnerabilities, a solution is provided for how to fix the vulnerability.  @@ -109,17 +108,16 @@ the vulnerability will now have an associated issue next to the name.  -### Solutions for vulnerabilities +### Solutions for vulnerabilities (auto-remediation) -> Introduced in [GitLab Ultimate](https://about.gitlab.com/pricing) 11.7. - -CAUTION: **Warning:** -Automatic Patch creation is only available for a subset of -[Dependency Scanning](dependency_scanning/index.md). At the moment only Node.JS -projects managed with yarn are supported. +> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/5656) in [GitLab Ultimate](https://about.gitlab.com/pricing) 11.7. Some vulnerabilities can be fixed by applying the solution that GitLab -automatically generates. +automatically generates. The following scanners are supported: + +- [Dependency Scanning](dependency_scanning/index.md): + Automatic Patch creation is only available for Node.JS projects managed with + `yarn`. #### Manually applying the suggested patch @@ -136,13 +134,12 @@ generated by GitLab. To apply the fix: #### Creating a merge request from a vulnerability -> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/9224) in -> [GitLab Ultimate](https://about.gitlab.com/pricing) 11.9. +> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/9224) in [GitLab Ultimate](https://about.gitlab.com/pricing) 11.9. In certain cases, GitLab will allow you to create a merge request that will automatically remediate the vulnerability. Any vulnerability that has a -[solution](#solutions-for-vulnerabilities) can have a merge request created to -automatically solve the issue. +[solution](#solutions-for-vulnerabilities-auto-remediation) can have a merge +request created to automatically solve the issue. If this action is available there will be a **Create merge request** button in the vulnerability modal. Clicking on this button will create a merge request to apply the solution onto the source branch. diff --git a/doc/user/markdown.md b/doc/user/markdown.md index edf2fedab3c..75a1ac8e9ff 100644 --- a/doc/user/markdown.md +++ b/doc/user/markdown.md @@ -1292,7 +1292,7 @@ Example: Additionally, you can choose the alignment of text within columns by adding colons (`:`) to the sides of the "dash" lines in the second row. This will affect every cell in the column. -> Note that the headers are always right aligned [within GitLab itself itself](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/user/markdown.md#tables). +> Note that the headers are always right aligned [within GitLab itself](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/user/markdown.md#tables). ```markdown | Left Aligned | Centered | Right Aligned | Left Aligned | Centered | Right Aligned | diff --git a/doc/user/profile/account/create_accounts.md b/doc/user/profile/account/create_accounts.md new file mode 100644 index 00000000000..c0a887d0779 --- /dev/null +++ b/doc/user/profile/account/create_accounts.md @@ -0,0 +1,36 @@ +--- +type: reference +--- + +# Creating users **(CORE ONLY)** + +You can create users: + +- Manually through the sign in page or Admin Area. +- Automatically through user authentication integrations. + +## Create users on sign in page + +If you have [sign-up enabled](../../admin_area/settings/sign_up_restrictions.md), users can create their own accounts using the **Register** tab on the sign in page. + + + +## Create users in admin area + +As an admin user, you can manually create users by: + +1. Navigating to **Admin Area > Overview > Users** (`/admin/users` page). +1. Selecting the **New User** button. + +You can also [create users through the API](../../../api/users.md) as an admin. + + + + + +## Create users through integrations + +Users will be: + +- Automatically created upon first login with the [LDAP integration](../../../administration/auth/ldap.md). +- Created when first logging in via an [OmniAuth provider](../../../integration/omniauth.md) if the `allow_single_sign_on` setting is present. diff --git a/doc/user/profile/account/img/admin_user_button.png b/doc/user/profile/account/img/admin_user_button.png Binary files differnew file mode 100644 index 00000000000..6be9c1e266a --- /dev/null +++ b/doc/user/profile/account/img/admin_user_button.png diff --git a/doc/user/profile/account/img/admin_user_form.png b/doc/user/profile/account/img/admin_user_form.png Binary files differnew file mode 100644 index 00000000000..ede96373c73 --- /dev/null +++ b/doc/user/profile/account/img/admin_user_form.png diff --git a/doc/user/profile/account/img/register_tab.png b/doc/user/profile/account/img/register_tab.png Binary files differnew file mode 100644 index 00000000000..73faa3edd1c --- /dev/null +++ b/doc/user/profile/account/img/register_tab.png diff --git a/doc/user/profile/index.md b/doc/user/profile/index.md index e5ccc8ee758..40b7294c3bb 100644 --- a/doc/user/profile/index.md +++ b/doc/user/profile/index.md @@ -8,6 +8,10 @@ Each GitLab account has a user profile, and settings. Your [profile](#user-profi contains information about you, and your GitLab activity. Your [settings](#profile-settings) allow you to customize some aspects of GitLab to suit yourself. +## Creating users + +There are several ways to create users on GitLab. See the [creating users documentation](account/create_accounts.md) for more details. + ## Signing in There are several ways to sign into your GitLab account. diff --git a/doc/user/project/canary_deployments.md b/doc/user/project/canary_deployments.md index 5068d2757be..d4c8bf0d309 100644 --- a/doc/user/project/canary_deployments.md +++ b/doc/user/project/canary_deployments.md @@ -2,7 +2,7 @@ > [Introduced][ee-1659] in [GitLab Premium][eep] 9.1. -A popular [Continuous Integration](https://en.wikipedia.org/wiki/Continuous_integration) +A popular [Continuous Deployment](https://en.wikipedia.org/wiki/Continuous_deployment) strategy, where a small portion of the fleet is updated to the new version of your application. diff --git a/doc/user/project/integrations/webhooks.md b/doc/user/project/integrations/webhooks.md index f5bc6cbd988..211bbdc2bb9 100644 --- a/doc/user/project/integrations/webhooks.md +++ b/doc/user/project/integrations/webhooks.md @@ -1327,3 +1327,6 @@ console: example.com - - [14/May/2014:07:45:26 EDT] "POST / HTTP/1.1" 200 0 - -> / ``` + +NOTE: **Note:** +You may need to [allow requests to the local network](../../../security/webhooks.md) for this receiver to be added. diff --git a/doc/user/project/merge_requests/index.md b/doc/user/project/merge_requests/index.md index aa58e971cc3..c19e96b4482 100644 --- a/doc/user/project/merge_requests/index.md +++ b/doc/user/project/merge_requests/index.md @@ -630,10 +630,7 @@ troubleshooting steps. ### Merge request cannot retrieve the pipeline status -This can occur for one of two reasons: - -- Sidekiq doesn't pick up the changes fast enough -- Because of the bug described in [#41545](https://gitlab.com/gitlab-org/gitlab-ce/issues/41545) +This can occur if Sidekiq doesn't pick up the changes fast enough. #### Sidekiq diff --git a/doc/user/project/merge_requests/merge_request_approvals.md b/doc/user/project/merge_requests/merge_request_approvals.md index ca9ddd91e0d..a18c2d3a21f 100644 --- a/doc/user/project/merge_requests/merge_request_approvals.md +++ b/doc/user/project/merge_requests/merge_request_approvals.md @@ -184,6 +184,10 @@ the merge request. To enable this feature: When this feature is enabled, all merge requests will need approval from one code owner per matched rule before it can be merged. +NOTE: **Note:** Only the `CODEOWNERS` file on the default branch is evaluated for +Merge Request approvals. If `CODEOWNERS` is changed on a non-default branch, those +changes will not affect approvals until merged to the default branch. + ## Overriding the merge request approvals default settings > Introduced in GitLab Enterprise Edition 9.4. @@ -196,7 +200,7 @@ If approvals are [set at the project level](#editing-approvals), the default configuration (number of required approvals and approvers) can be overridden for each merge request in that project. -One possible scenario would be to to assign a group of approvers at the project +One possible scenario would be to assign a group of approvers at the project level and change them later when creating or editing the merge request. First, you have to enable this option in the project's settings: diff --git a/doc/user/project/operations/tracing.md b/doc/user/project/operations/tracing.md index 3fb3be3c21f..91d0ae9d272 100644 --- a/doc/user/project/operations/tracing.md +++ b/doc/user/project/operations/tracing.md @@ -26,7 +26,7 @@ and [OpenShift](https://github.com/jaegertracing/jaeger-openshift). GitLab provides an easy way to open the Jaeger UI from within your project: -1. [Set up Jaeger](#deploying-jaeger) and configure your application using one of the +1. [Set up Jaeger](https://www.jaegertracing.io) and configure your application using one of the [client libraries](https://www.jaegertracing.io/docs/latest/client-libraries/). 1. Navigate to your project's **Settings > Operations** and provide the Jaeger URL. 1. Click **Save changes** for the changes to take effect. diff --git a/doc/user/project/pages/getting_started_part_four.md b/doc/user/project/pages/getting_started_part_four.md index d844d4222b1..80fa64b162d 100644 --- a/doc/user/project/pages/getting_started_part_four.md +++ b/doc/user/project/pages/getting_started_part_four.md @@ -53,9 +53,9 @@ write in the `.gitlab-ci.yml` the script you want to run so GitLab Runner will do it for you. It looks more complicated than it is. What you need to tell the Runner: -``` -$ gem install jekyll -$ jekyll build +```sh +gem install jekyll +jekyll build ``` ### Script diff --git a/doc/user/project/settings/index.md b/doc/user/project/settings/index.md index 58ccd8bf2ae..e0fb5c57784 100644 --- a/doc/user/project/settings/index.md +++ b/doc/user/project/settings/index.md @@ -32,6 +32,8 @@ links will be missing from the sidebar UI. You can still access them with direct links if you can access Merge Requests. This is deliberate, if you can see Issues or Merge Requests, both of which use Labels and Milestones, then you shouldn't be denied access to Labels and Milestones pages. +Project [Snippets](../../snippets.md) are enabled by default. + #### Disabling email notifications You can disable all email notifications related to the project by selecting the diff --git a/doc/user/snippets.md b/doc/user/snippets.md index 7b580a057f2..74f58a1a92b 100644 --- a/doc/user/snippets.md +++ b/doc/user/snippets.md @@ -33,6 +33,11 @@ overview that shows snippets you created and allows you to explore all snippets. If you want to discover snippets that belong to a specific project, you can navigate to the Snippets page via the left side navigation on the project page. +Project snippets are enabled and available by default, but they can +be disabled by navigating to your project's **Settings**, expanding +**Visibility, project features, permissions** and scrolling down to +**Snippets**. From there, you can toggle to disable them or select a +different visibility level from the dropdown menu. ## Snippet comments diff --git a/doc/workflow/lfs/lfs_administration.md b/doc/workflow/lfs/lfs_administration.md index 7e880b3009d..8db62997b51 100644 --- a/doc/workflow/lfs/lfs_administration.md +++ b/doc/workflow/lfs/lfs_administration.md @@ -134,13 +134,13 @@ There are two ways to manually do the same thing as automatic uploading (describ **Option 1: rake task** -``` -$ rake gitlab:lfs:migrate +```sh +rake gitlab:lfs:migrate ``` **Option 2: rails console** -``` +```sh $ sudo gitlab-rails console # Login to rails console > # Upload LFS files manually |
