You can also retrieve a single object by **specifying** the object name or full **DN**. In this example we specify the object name only `CN=Leroy Fox`.
You can also retrieve a single object by **specifying** the object name or full **DN**. In this example we specify the object name only `CN=Leroy Fox`.
@@ -390,7 +390,7 @@ to start again from scratch, there are a few steps that can help you:
You need to send a **SIGTSTP** kill signal for the first phase and them a **SIGTERM**
when all jobs have finished. Otherwise just use the `gitlab-ctl stop` commands.
```sh
```shell
gitlab-ctl status sidekiq
# run: sidekiq: (pid 10180) <- this is the PID you will use
kill-TSTP 10180 # change to the correct PID
...
...
@@ -401,13 +401,13 @@ to start again from scratch, there are a few steps that can help you:
You can watch Sidekiq logs to know when Sidekiq jobs processing have finished:
```sh
```shell
gitlab-ctl tail sidekiq
```
1. Rename repository storage folders and create new ones. If you are not concerned about possible orphaned directories and files, then you can simply skip this step.
@@ -16,7 +16,7 @@ This update will occur even if major PostgreSQL updates are disabled.
Before [refreshing Foreign Data Wrapper during a Geo HA upgrade](https://docs.gitlab.com/omnibus/update/README.html#run-post-deployment-migrations-and-checks),
restart the Geo tracking database:
```sh
```shell
sudo gitlab-ctl restart geo-postgresql
```
...
...
@@ -31,7 +31,7 @@ for the recommended procedure.
This can be temporarily disabled by running the following before updating:
```sh
```shell
sudo touch /etc/gitlab/disable-postgresql-upgrade
```
...
...
@@ -41,7 +41,7 @@ Before 10.8, broadcast messages would not propagate without flushing
the cache on the **secondary** nodes. This has been fixed in 10.8, but
requires one last cache flush on each **secondary** node:
```sh
```shell
sudo gitlab-rake cache:clear
```
...
...
@@ -55,7 +55,7 @@ authentication method.
1.**(primary)** Login to your **primary** node and run:
```sh
```shell
gitlab-ctl pg-password-md5 gitlab
# Enter password: <your_password_here>
# Confirm password: <your_password_here>
...
...
@@ -82,7 +82,7 @@ authentication method.
1.**(primary)** Reconfigure and restart:
```sh
```shell
sudo gitlab-ctl reconfigure
sudo gitlab-ctl restart
```
...
...
@@ -113,7 +113,7 @@ authentication method.
1.**(secondary)** Reconfigure and restart:
```sh
```shell
sudo gitlab-ctl reconfigure
sudo gitlab-ctl restart
```
...
...
@@ -129,7 +129,7 @@ contents of `/etc/gitlab/gitlab-secrets.json` on each **secondary** node with th
contents of `/etc/gitlab/gitlab-secrets.json` on the **primary** node, then run the
@@ -939,7 +939,7 @@ Confirm the following are all true:
- When [tailing the logs](https://docs.gitlab.com/omnibus/settings/logs.html#tail-logs-in-a-console-on-the-server) on an app node and reproducing the error, you get `401` errors
when reaching the `/api/v4/internal/allowed` endpoint:
| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user. |
| `scope` | string **or** array of strings | no | Scope of jobs to show. Either one of or an array of the following: `created`, `pending`, `running`, `failed`, `success`, `canceled`, `skipped`, or `manual`. All jobs are returned if `scope` is not provided. |
@@ -148,7 +148,7 @@ GET /projects/:id/pipelines/:pipeline_id/jobs
| `pipeline_id` | integer | yes | ID of a pipeline. |
| `scope` | string **or** array of strings | no | Scope of jobs to show. Either one of or an array of the following: `created`, `pending`, `running`, `failed`, `success`, `canceled`, `skipped`, or `manual`. All jobs are returned if `scope` is not provided. |
@@ -112,7 +112,7 @@ POST /projects/:id/pipeline_schedules
| `cron_timezone` | string | no | The timezone supported by `ActiveSupport::TimeZone` (e.g. `Pacific Time (US & Canada)`) (default: `'UTC'`) |
| `active` | boolean | no | The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially (default: `true`) |
```sh
```shell
curl --request POST --header"PRIVATE-TOKEN: k5ESFgWY2Qf5xEvDcFxZ"--formdescription="Build packages"--formref="master"--formcron="0 1 * * 5"--formcron_timezone="UTC"--formactive="true""https://gitlab.example.com/api/v4/projects/29/pipeline_schedules"
```
...
...
@@ -157,7 +157,7 @@ PUT /projects/:id/pipeline_schedules/:pipeline_schedule_id
| `cron_timezone` | string | no | The timezone supported by `ActiveSupport::TimeZone` (e.g. `Pacific Time (US & Canada)`) or `TZInfo::Timezone` (e.g. `America/Los_Angeles`) |
| `active` | boolean | no | The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially. |
```sh
```shell
curl --request PUT --header"PRIVATE-TOKEN: k5ESFgWY2Qf5xEvDcFxZ"--formcron="0 2 * * *""https://gitlab.example.com/api/v4/projects/29/pipeline_schedules/13"
```
...
...
@@ -202,7 +202,7 @@ POST /projects/:id/pipeline_schedules/:pipeline_schedule_id/take_ownership
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `pipeline_schedule_id` | integer | yes | The pipeline schedule id |
```sh
```shell
curl --request POST --header"PRIVATE-TOKEN: hf2CvZXB9w8Uc5pZKpSB""https://gitlab.example.com/api/v4/projects/29/pipeline_schedules/13/take_ownership"
--request POST https://gitlab.example.com/api/v4/projects/24/releases
...
...
@@ -445,7 +445,7 @@ PUT /projects/:id/releases/:tag_name
Example request:
```sh
```shell
curl --header'Content-Type: application/json'--request PUT --data'{"name": "new name", "milestones": ["v1.2"]}'--header"PRIVATE-TOKEN: gDybLx3yrUK_HLp3qPjS""https://gitlab.example.com/api/v4/projects/24/releases/v0.1"
-`id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
-`sha` (optional) - The commit SHA to download. A tag, branch reference, or SHA can be used. This defaults to the tip of the default branch if not specified. For example:
@@ -21,7 +21,7 @@ PUT /projects/:id/repository/submodules/:submodule
| `commit_sha` | string | yes | Full commit SHA to update the submodule to |
| `commit_message` | string | no | Commit message. If no message is provided, a default one will be set |
```sh
```shell
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/repository/submodules/lib%2Fmodules%2Fexample"
@@ -33,7 +33,7 @@ Find here the [source code setting the attribute](https://gitlab.com/gitlab-org/
The `rake routes` command can be used to list all the routes available in the application, piping the output into `grep`, we can perform a search through the list of available routes.
The output includes the request types available, route parameters and the relevant controller.
curl --request POST --header"Gitlab-Shared-Secret: <Base64 encoded token>"--data"key_id=11&project=gnuwget/wget2&action=git-upload-pack&protocol=ssh" http://localhost:3001/api/v4/internal/allowed
```
...
...
@@ -99,7 +99,7 @@ information for LFS clients when the repository is accessed over SSH.
Example request:
```sh
```shell
curl --request POST --header"Gitlab-Shared-Secret: <Base64 encoded token>"--data"key_id=11&project=gnuwget/wget2" http://localhost:3001/api/v4/internal/lfs_authenticate
```
...
...
@@ -132,7 +132,7 @@ GET /internal/authorized_keys
Example request:
```sh
```shell
curl --request GET --header"Gitlab-Shared-Secret: <Base64 encoded secret>""http://localhost:3001/api/v4/internal/authorized_keys?key=<key as passed by OpenSSH>"
```
...
...
@@ -167,7 +167,7 @@ GET /internal/discover
Example request:
```sh
```shell
curl --request GET --header"Gitlab-Shared-Secret: <Base64 encoded secret>""http://localhost:3001/api/v4/internal/discover?key_id=7"
```
...
...
@@ -196,7 +196,7 @@ GET /internal/check
Example request:
```sh
```shell
curl --request GET --header"Gitlab-Shared-Secret: <Base64 encoded secret>""http://localhost:3001/api/v4/internal/check"
```
...
...
@@ -232,7 +232,7 @@ GET /internal/two_factor_recovery_codes
Example request:
```sh
```shell
curl --request POST --header"Gitlab-Shared-Secret: <Base64 encoded secret>"--data"key_id=7" http://localhost:3001/api/v4/internal/two_factor_recovery_codes
```
...
...
@@ -275,7 +275,7 @@ POST /internal/pre_receive
Example request:
```sh
```shell
curl --request POST --header"Gitlab-Shared-Secret: <Base64 encoded secret>"--data"gl_repository=project-7" http://localhost:3001/api/v4/internal/pre_receive
```
...
...
@@ -307,7 +307,7 @@ POST /internal/post_receive
Example Request:
```sh
```shell
curl --request POST --header"Gitlab-Shared-Secret: <Base64 encoded secret>"--data"gl_repository=project-7"--data"identifier=user-1"--data"changes=0000000000000000000000000000000000000000 fd9e76b9136bdd9fe217061b497745792fe5a5ee gh-pages\n" http://localhost:3001/api/v4/internal/post_receive
Having the JSON, you finally could render a picture using the script [provided by Aaron](https://gist.github.com/tenderlove/f28373d56fdd03d8b514af7191611b88) or similar:
@@ -91,7 +91,7 @@ The GitLab installation consists of setting up the following components:
`sudo` is not installed on Debian by default. Make sure your system is
up-to-date and install it.
```sh
```shell
# run as root!
apt-get update -y
apt-get upgrade -y
...
...
@@ -101,7 +101,7 @@ apt-get install sudo -y
NOTE: **Note:**
During this installation, some files will need to be edited manually. If you are familiar with vim, set it as default editor with the commands below. If you are not familiar with vim, skip this and keep using the default editor.
Is the system packaged Git too old, or not compiled with pcre2? Remove it and compile from source:
```sh
```shell
# Remove packaged Git
sudo apt-get remove git-core
...
...
@@ -186,13 +186,13 @@ sudo make prefix=/usr/local install
For the [Custom Favicon](../user/admin_area/appearance.md#favicon) to work, GraphicsMagick
needs to be installed.
```sh
```shell
sudo apt-get install-y graphicsmagick
```
**Note:** In order to receive mail notifications, make sure to install a mail server. By default, Debian is shipped with exim4 but this [has problems](https://gitlab.com/gitlab-org/gitlab-foss/issues/12754) while Ubuntu does not ship with one. The recommended mail server is postfix and you can install it with:
```sh
```shell
sudo apt-get install-y postfix
```
...
...
@@ -216,13 +216,13 @@ instructions are designed to install Ruby from the official source code.
# Remove host, username, and password lines from config/database.yml.
...
...
@@ -539,7 +539,7 @@ Make sure you have `bundle` (run `bundle -v`):
-`>= 1.5.2`, because some [issues](https://devcenter.heroku.com/changelog-items/411) were [fixed](https://github.com/bundler/bundler/pull/2817) in 1.5.2.
-`< 2.x`.
```sh
```shell
sudo-u git -H bundle install--deployment--without development test mysql aws kerberos
```
...
...
@@ -550,7 +550,7 @@ If you want to use Kerberos for user authentication, omit `kerberos` in the `--w
GitLab Shell is an SSH access and repository management software developed specially for GitLab.
```sh
```shell
# Run the installation task for gitlab-shell (replace `REDIS_URL` if needed):
@@ -611,7 +611,7 @@ You will then need to update `gitlab.yml`'s `production -> elasticsearch -> inde
GitLab Pages uses [GNU Make](https://www.gnu.org/software/make/). This step is optional and only needed if you wish to host static sites from within GitLab. The following commands will install GitLab Pages in `/home/git/gitlab-pages`. For additional setup steps, consult the [administration guide](https://gitlab.com/gitlab-org/gitlab/blob/master/doc/administration/pages/source.md) for your version of GitLab as the GitLab Pages daemon can be run several different ways.
You can set the Administrator/root password and e-mail by supplying them in environmental variables, `GITLAB_ROOT_PASSWORD` and `GITLAB_ROOT_EMAIL` respectively, as seen below. If you don't set the password (and it is set to the default one), wait to expose GitLab to the public internet until the installation is done and you've logged into the server the first time. During the first login, you'll be forced to change the default password. An Enterprise Edition license may also be installed at this time by supplying a full path in the `GITLAB_LICENSE_FILE` environment variable.
Make sure to edit the config file to match your setup. Also, ensure that you match your paths to GitLab, especially if installing for a user other than the `git` user:
```sh
```shell
# Change YOUR_SERVER_FQDN to the fully-qualified
# domain name of your host serving GitLab.
#
...
...
@@ -794,7 +794,7 @@ to use. Read all about the needed configuration at the
Validate your `gitlab` or `gitlab-ssl` NGINX config file with the following command:
```sh
```shell
sudo nginx -t
```
...
...
@@ -807,7 +807,7 @@ nginx: configuration file /etc/nginx/nginx.conf test failed`
### Restart
```sh
```shell
sudo service nginx restart
```
...
...
@@ -817,7 +817,7 @@ sudo service nginx restart
To make sure you didn't miss anything run a more thorough check with:
@@ -346,7 +346,7 @@ or creating [extra Sidekiq processes](../administration/operations/extra_sidekiq
1. Personal snippets are not associated with a project and need to be indexed separately
by running one of these commands:
```sh
```shell
# Omnibus installations
sudo gitlab-rake gitlab:elastic:index_snippets
...
...
@@ -437,7 +437,7 @@ In addition to the rake tasks, there are some environment variables that can be
Because the `ID_TO` and `ID_FROM` environment variables use the `or equal to` comparison, you can index only one project by using both these variables with the same project ID number:
@@ -102,7 +102,7 @@ If you are using the [GitLab Helm chart](https://gitlab.com/gitlab-org/charts/gi
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:
@@ -204,7 +204,7 @@ installations. This is why the `copy` strategy is not the default in 8.17.
To use the `copy` strategy instead of the default streaming strategy, specify
`STRATEGY=copy` in the Rake task command. For example:
```sh
```shell
sudo gitlab-backup create STRATEGY=copy
```
...
...
@@ -215,7 +215,7 @@ For GitLab 12.1 and earlier, use `gitlab-rake gitlab:backup:create`.
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:
```sh
```shell
sudo gitlab-backup create BACKUP=dump
```
...
...
@@ -230,7 +230,7 @@ To make sure the generated archive is intelligently transferable by rsync, the `
Note that the `--rsyncable` option in `gzip` is not guaranteed to be available on all distributions. To verify that it is available in your distribution you can run `gzip --help` or consult the man pages.
@@ -102,7 +102,7 @@ Once the remote is set, you can use the remote when running Conan commands by ad
For example:
```sh
```shell
conan search Hello*--all--remote=gitlab
```
...
...
@@ -114,7 +114,7 @@ You will need to generate a [personal access token](../../../user/profile/person
Once you have a personal access token and have [set your Conan remote](#adding-the-gitlab-package-registry-as-a-conan-remote), you can associate the token with the remote so you do not have to explicitly add them to each Conan command you run:
```sh
```shell
conan user <gitlab-username> -r gitlab -p <personal_access_token>
```
...
...
@@ -129,7 +129,7 @@ The personal access token is not stored locally at any moment. Conan uses JWT, s
Alternatively, you could explicitly include your credentials in any given command.
@@ -137,7 +137,7 @@ CONAN_LOGIN_USERNAME=<gitlab-username> CONAN_PASSWORD=<personal_access_token> co
If you'd like Conan to always use GitLab as the registry for your package, you can tell Conan to always reference the GitLab remote for a given package recipe:
@@ -147,7 +147,7 @@ This functionality is best suited for when you want to consume or install packag
The rest of the example commands in this documentation assume that you have added a Conan user with your credentials to the `gitlab` remote and will not include the explicit credentials or remote option, but be aware that any of the commands could be run without having added a user or default remote:
@@ -80,6 +80,6 @@ if your project is located at `https://gitlab.com/foo/bar/my-proj`, then you can
using `conan create . foo+bar+my-proj/channel`, where `channel` is your package channel (`stable`, `beta`, etc.). Once your package
is created, you are ready to [upload your package](../conan_repository/index.md#uploading-a-package) depending on your final package recipe. For example: