feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: Describe using OpenSSH connections

Browse Source 
...to connect to embedded Linux devices.

Change-Id: Icd4196a25cf99928d929c70df17cd0f7e271abf6
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
This commit is contained in:
Leena Miettinen
2019-01-03 13:09:04 +01:00
parent 57d9e6cb48
commit 87630cce25
7 changed files with 73 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
doc/src/linux-mobile/linuxdev.qdoc
View File

@@ -1,6 +1,6 @@
/****************************************************************************
**
** Copyright (C) 2018 The Qt Company Ltd.
** Copyright (C) 2019 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
@@ -50,13 +50,21 @@
add devices and select them in the \QC \l{glossary-buildandrun-kit}{kit}.
You use a wizard to create the connections. You can edit the settings later
in \uicontrol Tools > \uicontrol Options > \uicontrol Devices.
in \uicontrol Tools > \uicontrol Options > \uicontrol Devices >
\uicontrol Devices.
\image qtcreator-linux-device-configurations.png "Devices dialog"
You can protect the connections between \QC and a device by using
either a password or an SSH key. If you do not have an SSH key, you can
create it in \QC. For more information, see \l {Generating SSH Keys}.
You can protect the connections between \QC and a device by using an
\l{https://www.openssh.com/}{OpenSSH} connection. OpenSSH is a
connectivity tool for remote login using the SSH protocol. The OpenSSH
suite is not delivered with \QC, so you must download it and install it
on the development PC. Then, you must configure the paths to the tools in
\QC. For more information, see \l {Configuring SSH Connections}.
You need either a password or an SSH public and private key pair for
authentication. If you do not have an SSH key, you can use the ssh-keygen
tool to create it in \QC. For more information, see \l {Generating SSH Keys}.
To configure connections between \QC and an embedded Linux device and to
specify build and run settings for the device:
@@ -78,8 +86,9 @@
\list 1
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Devices
> \uicontrol Add > \uicontrol {Generic Linux Device}
\li Select \uicontrol Tools > \uicontrol Options >
\uicontrol Devices > \uicontrol Devices > \uicontrol Add >
\uicontrol {Generic Linux Device}
> \uicontrol {Start Wizard}.
\image qtcreator-screenshot-devconf-linux.png "Connection Data wizard"
@@ -96,11 +105,12 @@
application as.
This value will be available in the variable \c %{Device:UserName}.
\li In the \uicontrol {The authentication type} field, select whether
to use \uicontrol Password or \uicontrol Key authentication, and enter
the user's password or the file that contains the user's
private key.
The latter will be available in the variable \c %{Device:PrivateKeyFile}.
\li In the \uicontrol {The authentication type} field, select
\uicontrol Default to use the currently displayed private
key file for authentication. Select \uicontrol {Specific Key}
to use some other key, and enter the path to the file that
contains the private key in the field below. This value will
be available in the variable \c %{Device:PrivateKeyFile}.
\li Click \uicontrol {Next} to create the connection.
@@ -137,6 +147,7 @@
\endlist
\include linux-mobile/linuxdev-keys.qdocinc configuring ssh
\include linux-mobile/linuxdev-keys.qdocinc generating ssh keys
\include linux-mobile/linuxdev-processes.qdocinc managing device processes
*/