From 93e933b2bad2cc5efb0d470466a4bd37a5ffa33d Mon Sep 17 00:00:00 2001
From: Bram Prieshof <bram@bprieshof.nl>
Date: Sun, 17 Jan 2021 02:37:02 +0100
Subject: [PATCH] Added readme

---
 readme.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 53 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..8f81fd0
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,53 @@
+# ShellHub Native
+### Running ShellHub without docker, copiled on local Jenkins
+
+## Script Compatibility
+Stable
+* Ubuntu 18.04
+* EL8 (Centos 8, etc)
+Latest and Latest_Tested
+* Ubuntu 18.04 and 20.04
+* Debian 10
+* EL8 (Centos 8, etc)
+
+## Installing
+**For all builds**
+1. install git `apt -y install git` or `dnf install -y git` 
+2. Clone repo ```git clone https://git.bprieshof.nl/Tools/ShellHubNative```
+
+**Latest_Tested (default if install.sh is not changed)**
+1. Run script ```bash ShellHubNative/Server/install.sh```
+2. Add user ```/opt/ShellHub/tools/add-user <Username> <Password> <Email>```
+3. Add name space ```/opt/ShellHub/tools/add-namespace <Username> <Username>```
+
+**Latest**
+1. edit Server/install.sh ```nano ShellHubNative/Server/install.sh```
+2. Comment out `RelVer=latest_Tested` and `Un-comment RelVer=latest`
+3. Run script ```bash ShellHubNative/Server/install.sh```
+4. Add user ```/opt/ShellHub/tools/add-user <Username> <Password> <Email>```
+5. Add name space ```/opt/ShellHub/tools/add-namespace <Username> <Username>```
+
+**Stable (current release tag from ShellHub git)**  
+
+**Warning**: Current stable wil only run if mongodb 3.6 is available (Centos 8 and ubuntu 18.04)
+1. edit Server/install.sh ```nano ShellHubNative/Server/install.sh```
+2. Comment out `RelVer=latest_Tested` and `Un-comment RelVer=stable`
+3. Set `MongoVer=*` to `MongoVer=3.6`
+4. Run script ```bash ShellHubNative/Server/install.sh```
+5. Add user ```/opt/ShellHub/tools/add-user <Username> <Password> <Email>```
+
+**Quick install ofLatest_Tested**
+``` 
+git clone https://git.bprieshof.nl/Tools/ShellHubNative
+bash ShellHubNative/Server/install.sh
+```
+
+## Notes
+Tools can be found in ` /opt/ShellHub/tools/`
+
+## Links
+ShellHub project on GitHub: https://github.com/shellhub-io/shellhub  
+Builds Published on: https://git.bprieshof.nl/ci/  
+#### BuildServer (jenkins)
+Stable build: https://git.bprieshof.nl/ci/job/Public/job/ShellHub_TAGGED/  
+Latest build : https://git.bprieshof.nl/ci/job/Public/job/ShellHub/