Skip to content

Commit f18b7ef

Browse files
committed
doc: develop: manifests: external: add wolfSSH
Add documentation to external module section for adding wolfSSH to Zephyr Signed-off-by: Zackery Backman <[email protected]>
1 parent 7670121 commit f18b7ef

File tree

1 file changed

+71
-0
lines changed

1 file changed

+71
-0
lines changed
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
.. _external_module_wolfssh:
2+
3+
wolfSSH
4+
#######
5+
6+
Introduction
7+
************
8+
9+
wolfSSH is a lightweight, portable SSH library optimized for embedded systems, RTOS environments, and resource-constrained devices. It provides secure shell functionality including SSH server and client implementations, SCP, and SFTP support. Its support for multiple build configurations makes it suitable for a wide range of applications and hardware platforms that are utilizing the Zephyr RTOS.
10+
11+
wolfSSH has support for the Zephyr networking stack so applications can use the wolfSSH API to establish secure SSH connections with other devices or services over the network.
12+
13+
wolfSSH is dual licensed under GPLv3 and commercial licenses.
14+
15+
GitHub Repository: `wolfSSH Repository`_
16+
17+
Requirements
18+
************
19+
20+
* :ref:`external_module_wolfssl` for cryptographic operations
21+
22+
Usage with Zephyr
23+
*****************
24+
25+
Add wolfSSH as a project to your west.yml:
26+
27+
.. code-block:: yaml
28+
29+
manifest:
30+
remotes:
31+
# <your other remotes>
32+
- name: wolfssh
33+
url-base: https://github.com/wolfssl
34+
projects:
35+
# <your other projects>
36+
- name: wolfssh
37+
path: modules/lib/wolfssh
38+
revision: master
39+
remote: wolfssh
40+
41+
Update west's modules:
42+
43+
.. code-block:: bash
44+
45+
west update
46+
47+
Now west recognizes ``wolfssh`` as a module, and will include its Kconfig and
48+
CMakeLists.txt in the build system.
49+
50+
For more regarding the usage of wolfSSH with Zephyr, please refer to the `wolfSSH Zephyr Example Usage`_.
51+
52+
For application code examples in Zephyr, please refer to the `wolfSSL NXP AppCodeHub`_.
53+
54+
For wolfSSH API documentation, please refer to the `wolfSSH Documentation`_.
55+
56+
Reference
57+
*********
58+
59+
.. target-notes::
60+
61+
.. _wolfSSH Repository:
62+
https://github.com/wolfSSL/wolfssh
63+
64+
.. _wolfSSH Zephyr Example Usage:
65+
https://github.com/wolfSSL/wolfssh/blob/master/zephyr/README.md#build-and-run-samples
66+
67+
.. _wolfSSL NXP AppCodeHub:
68+
https://github.com/wolfSSL/nxp-appcodehub
69+
70+
.. _wolfSSH Documentation:
71+
https://www.wolfssl.com/documentation/manuals/wolfssh/

0 commit comments

Comments
 (0)