Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added ssh runner documentation and example #3972

Open
wants to merge 4 commits into
base: develop2
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Removed ssh. prefix on runner config
perseoGI committed Feb 6, 2025
commit 86715693d8e107883648f8e1b1d527304a9a5023
4 changes: 2 additions & 2 deletions examples/runners/ssh/basic.rst
Original file line number Diff line number Diff line change
@@ -58,8 +58,8 @@ In this case, the runner will be a Windows virtual machine.

[runner]
type=ssh
ssh.configfile=False
ssh.host=10.211.55.3
configfile=False
host=10.211.55.3


For this example, we are going to start from a clean environment.
8 changes: 4 additions & 4 deletions reference/runners/ssh.rst
Original file line number Diff line number Diff line change
@@ -11,8 +11,8 @@ How to use a SSH runner
To run Conan inside a docker container you need to define a ``[runner]`` section in your host profile using the following fields:

- ``type`` **(mandatory)**: define the runner we want to use, in this case ``ssh``.
- ``ssh.host`` **(mandatory)**: hostname of the runner to connect to. This runner has to be already accessible by the host machine via SSH protocol and must have ``python3`` installed.
- ``ssh.configfile`` **(optional, default False)**: if True, Conan will retrieve the ssh configuration from the default location (``~/.ssh/config``). It can also accept an absolute path to the file.
- ``host`` **(mandatory)**: hostname of the runner to connect to. This runner has to be already accessible by the host machine via SSH protocol and must have ``python3`` installed.
- ``configfile`` **(optional, default False)**: if True, Conan will retrieve the ssh configuration from the default location (``~/.ssh/config``). It can also accept an absolute path to the file.

.. note::

@@ -38,8 +38,8 @@ In conan host profile:

[runner]
type=ssh
ssh.configfile=True
ssh.host=windows-vm
configfile=True
host=windows-vm


How to run a `conan create` in a runner