Commit d705b3ec authored by Andrew Winata's avatar Andrew Winata Committed by Evan Read

Apply suggestions to shell docs

Applying wording changes from a review for !1209
parent 9d3538ff
......@@ -111,7 +111,7 @@ This defines one runner entry.
| `tls-key-file` | File containing the private key to authenticate with the peer when using HTTPS |
| `limit` | Limit how many jobs can be handled concurrently by this token. `0` (default) simply means don't limit |
| `executor` | Select how a project should be built, see next section |
| `shell` | The name of shell to generate the script (default value is platform dependent) |
| `shell` | Name of shell to generate the script. Default value is [platform dependent](../shells/index.md#overview). |
| `builds_dir` | Directory where builds will be stored in context of selected executor (Locally, Docker, SSH) |
| `cache_dir` | Directory where build caches will be stored in context of selected executor (locally, Docker, SSH). If the `docker` executor is used, this directory needs to be included in its `volumes` parameter. |
| `environment` | Append or overwrite environment variables |
......
......@@ -54,6 +54,19 @@ usermod -aG docker gitlab-runner
usermod -aG vboxusers gitlab-runner
```
## Selecting your shell
GitLab Runner [supports certain shells](../shells/index.md). To select a shell, specify it in your `config.toml` file. For example:
```toml
...
[[runners]]
name = "shell executor runner"
executor = "shell"
shell = "powershell"
...
```
## Security
Generally it's unsafe to run tests with shell executors. The jobs are run with
......
......@@ -25,6 +25,8 @@ The currently supported shells are:
| `cmd` | Windows Batch script. All commands are executed in Batch context (default for Windows) |
| `powershell` | Windows PowerShell script. All commands are executed in PowerShell context |
If you want to select a particular shell to use other than the default, you will need to [specify the shell](https://docs.gitlab.com/runner/executors/shell.html#selecting-your-shell) in your `config.toml` file.
## Sh/Bash shells
This is the default shell used on all Unix based systems. The bash script used
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment