module-ssh2/README at develop · qoretechnologies/module-ssh2 · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
Qore ssh2 module

INTRODUCTION
------------
This module provides access to ssh2 sessions and the sftp protocol via libssh2
(http://www.libssh2.org) in the Qore programming language.

This version requires qore 3.0+ and the sshutil module for shared SSH
credential and host-key provider types.

LICENSE
-------
This module is released under a choice of two licenses: LGPL 2.1 and MIT, see
COPYING.LGPL and COPYING.MIT for more information

BINARIES
--------
For Linux RPMs for many distributions, see the opensuse build service:
    http://download.opensuse.org/repositories/devel:/languages:/misc/

For OS/X, use macports: http://www.macports.org
    sudo port selfupdate
    sudo port -vu install qore-ssh2-module


BUILDING
--------
Requires cmake 3.5+, a C++17 compiler, qore 3.0+, sshutil, and libssh2 1.1+ to
build and run

to configure and build the module, execute

        mkdir build
        cd build
        cmake .. -DCMAKE_BUILD_TYPE=Release
        make

The install prefix must match the prefix of the qore installation in use; if
"which qore" gives "/usr/bin/qore", for example, then configure the build with

        cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr

libssh2 is located with pkg-config; if it is installed in a non-standard
location, set PKG_CONFIG_PATH accordingly before running cmake (on Windows and
MinGW builds, set the LIBSSH2_LIBRARY environment variable instead)

The qore binary also needs to be in the path so that the build can determine the
module directory

Then execute

make install

(or 'sudo make install' as needed)

to build the API documentation, execute

make docs

please direct any questions to:
david@qore.org

or you can post in the qore forums at
        http://qore.org/forums

TESTING
-------
The SSH and SFTP suites accept --uri for the test server, for example:

    qore -b --enable-debug test/Ssh2Client.qtest --uri=ssh://tester@127.0.0.1:2222

RPM qualification creates its own isolated SSH server, temporary home, and
fresh keys; see rpm/README.rst for build and installed-package checks.