Skip to content

Commit 1177293

Browse files
Add user manual
1 parent 0992de9 commit 1177293

File tree

3 files changed

+25
-0
lines changed

3 files changed

+25
-0
lines changed

docs/user-manual/index.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
This manual covers usage of the ShellHub Agent and ShellHub UI.
2+

docs/user-manual/installing.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
ShellHub Agent is designed to run on all your systems: physical and virtual servers, even IoT/edge devices.
2+
3+
The best way to install ShellHub Agent is with our automatic one-line installation script, which works with all Linux distributions that have Docker installed and properly set up.
4+
5+
If you want to install ShellHub without Docker you can try to build by yourself or if you are targeting embedded devices checkout our [Yocto Project support layer for ShellHub](https://github.com/shellhub-io/meta-shellhub).
6+
7+
## One-line installation script
8+
9+
!!! info "Docker installed and properly set up on device is required"
10+
Follow the [Docker Install Instructions](http://docs.docker.com/installation/) for your distro/platform.
11+
You should always use the latest docker version. The minimum supported Docker version is `18.06`.
12+
13+
Open the ShellHub UI, navigate to _Devices_ on the sidebar, and click on _ADD DEVICE_. It should give you a registration command for installing ShellHub Agent that you need to run on your device:
14+
15+
![Device Register](/img/register-device.png)
16+
17+
After running the command on your device, you'll need to accept the device on the ShellHub UI in order to complete enrollment.
18+
Go to _Devices_ -> _Pending_ locate your device and click _Accept_ button.
19+
20+
After your device is enrolled, it becomes available in _Device List_ page.

mkdocs.yml

+3
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,9 @@ nav:
9898
- Running: admin-manual/running.md
9999
- Managing: admin-manual/managing.md
100100
- Production Deployment: admin-manual/production-deployment.md
101+
- User Manual:
102+
- Introduction: user-manual/index.md
103+
- Installing: user-manual/installing.md
101104
- Troubleshooting:
102105
Frequently Encountered Issues: troubleshooting.md
103106
# Extra data

0 commit comments

Comments
 (0)