mirror of https://github.com/wolfSSL/wolfssh.git
Merge pull request #358 from JacobBarthelmeh/doc
commit
c0ba16f1b1
10
README
10
README
|
@ -2,29 +2,33 @@ WOLFSSH
|
||||||
=======
|
=======
|
||||||
|
|
||||||
wolfSSL's Embeddable SSH Server
|
wolfSSL's Embeddable SSH Server
|
||||||
|
[wolfSSH Manual](https://www.wolfssl.com/docs/wolfssh-manual/)
|
||||||
|
|
||||||
dependencies
|
dependencies
|
||||||
------------
|
------------
|
||||||
|
|
||||||
wolfSSH is dependent on wolfCrypt. The simplest configuration of wolfSSL
|
[wolfSSH](https://www.wolfssl.com/wolfssh/) is dependent on [wolfCrypt](https://www.wolfssl.com/download/).
|
||||||
required for wolfSSH is the default build.
|
The simplest configuration of wolfSSL required for wolfSSH is the default build.
|
||||||
|
|
||||||
$ cd wolfssl
|
$ cd wolfssl
|
||||||
$ ./configure [OPTIONS] --enable-ssh
|
$ ./configure [OPTIONS] --enable-ssh
|
||||||
$ make check
|
$ make check
|
||||||
$ sudo make install
|
$ sudo make install
|
||||||
|
|
||||||
|
On some systems the optional ldconfig command is needed after installing.
|
||||||
|
|
||||||
To use the key generation function in wolfSSH, wolfSSL will need to be
|
To use the key generation function in wolfSSH, wolfSSL will need to be
|
||||||
configured with keygen: `--enable-keygen`.
|
configured with keygen: `--enable-keygen`.
|
||||||
|
|
||||||
If the bulk of wolfSSL code isn't desired, wolfSSL can be configured with
|
If the bulk of wolfSSL code isn't desired, wolfSSL can be configured with
|
||||||
the crypto only option: `--enable-cryptonly`.
|
the crypto only option: `--enable-cryptonly`.
|
||||||
|
|
||||||
|
Additional build options for wolfSSL are located [here](https://www.wolfssl.com/docs/wolfssl-manual/ch2/).
|
||||||
|
|
||||||
building
|
building
|
||||||
--------
|
--------
|
||||||
|
|
||||||
From the source directory run:
|
From the wolfSSH source directory run:
|
||||||
|
|
||||||
$ ./autogen.sh
|
$ ./autogen.sh
|
||||||
$ ./configure
|
$ ./configure
|
||||||
|
|
10
README.md
10
README.md
|
@ -2,29 +2,33 @@ WOLFSSH
|
||||||
=======
|
=======
|
||||||
|
|
||||||
wolfSSL's Embeddable SSH Server
|
wolfSSL's Embeddable SSH Server
|
||||||
|
[wolfSSH Manual](https://www.wolfssl.com/docs/wolfssh-manual/)
|
||||||
|
|
||||||
dependencies
|
dependencies
|
||||||
------------
|
------------
|
||||||
|
|
||||||
wolfSSH is dependent on wolfCrypt. The simplest configuration of wolfSSL
|
[wolfSSH](https://www.wolfssl.com/wolfssh/) is dependent on [wolfCrypt](https://www.wolfssl.com/download/).
|
||||||
required for wolfSSH is the default build.
|
The simplest configuration of wolfSSL required for wolfSSH is the default build.
|
||||||
|
|
||||||
$ cd wolfssl
|
$ cd wolfssl
|
||||||
$ ./configure [OPTIONS] --enable-ssh
|
$ ./configure [OPTIONS] --enable-ssh
|
||||||
$ make check
|
$ make check
|
||||||
$ sudo make install
|
$ sudo make install
|
||||||
|
|
||||||
|
On some systems the optional ldconfig command is needed after installing.
|
||||||
|
|
||||||
To use the key generation function in wolfSSH, wolfSSL will need to be
|
To use the key generation function in wolfSSH, wolfSSL will need to be
|
||||||
configured with keygen: `--enable-keygen`.
|
configured with keygen: `--enable-keygen`.
|
||||||
|
|
||||||
If the bulk of wolfSSL code isn't desired, wolfSSL can be configured with
|
If the bulk of wolfSSL code isn't desired, wolfSSL can be configured with
|
||||||
the crypto only option: `--enable-cryptonly`.
|
the crypto only option: `--enable-cryptonly`.
|
||||||
|
|
||||||
|
Additional build options for wolfSSL are located [here](https://www.wolfssl.com/docs/wolfssl-manual/ch2/).
|
||||||
|
|
||||||
building
|
building
|
||||||
--------
|
--------
|
||||||
|
|
||||||
From the source directory run:
|
From the wolfSSH source directory run:
|
||||||
|
|
||||||
$ ./autogen.sh
|
$ ./autogen.sh
|
||||||
$ ./configure
|
$ ./configure
|
||||||
|
|
Loading…
Reference in New Issue