Skip to content
This repository was archived by the owner on Aug 24, 2022. It is now read-only.

Commit ea8cd9d

Browse files
Add installing from source code guide
1 parent 1177293 commit ea8cd9d

File tree

1 file changed

+27
-5
lines changed

1 file changed

+27
-5
lines changed

docs/user-manual/installing.md

+27-5
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
ShellHub Agent is designed to run on all your systems: physical and virtual servers, even IoT/edge devices.
2-
31
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).
2+
If you want to install ShellHub without Docker you can try to [install from source code](#installing-from-source-code) or if you are targeting embedded devices checkout our [Yocto Project support layer for ShellHub](https://github.com/shellhub-io/meta-shellhub).
63

74
## One-line installation script
85

9-
!!! info "Docker installed and properly set up on device is required"
6+
!!! info "Prerequisites"
7+
Docker installed and properly set up on device is required.
108
Follow the [Docker Install Instructions](http://docs.docker.com/installation/) for your distro/platform.
119
You should always use the latest docker version. The minimum supported Docker version is `18.06`.
1210

@@ -18,3 +16,27 @@ After running the command on your device, you'll need to accept the device on th
1816
Go to _Devices_ -> _Pending_ locate your device and click _Accept_ button.
1917

2018
After your device is enrolled, it becomes available in _Device List_ page.
19+
20+
## Installing from source code
21+
22+
!!! info "Prerequisites"
23+
ShellHub Agent requires Go 1.14 to compile, please refer to the [official documentation](https://golang.org/doc/install) for how to install Go in your system.
24+
25+
### Checkout source code
26+
27+
First checkout the latest stable version (*{{ shellhub.latest_version }}*) of ShellHub as follows:
28+
29+
```
30+
git clone -b {{ shellhub.latest_version }} https://github.com/shellhub-io/shellhub.git shellhub
31+
```
32+
33+
### Building
34+
35+
Execute the following command to build ShellHub Agent:
36+
37+
```
38+
cd shellhub/agent
39+
go build
40+
```
41+
42+
Use `file ./agent` to check if executable was built.

0 commit comments

Comments
 (0)