├── Configuration Guides.md
├── Jenkins Build.md
├── Jenkins and Git Config
├── Jenkins and Mocha Security Testing
├── README.md
├── cheat
├── development-pipeline.pdf
├── pics
    ├── build trigger and env.png
    ├── deploy.png
    ├── destroy containers.png
    ├── git settings.png
    ├── git ssh keys.png
    ├── nightly  build.png
    ├── push to git.png
    └── source code management.png
└── simon network.pdf


/Configuration Guides.md:
--------------------------------------------------------------------------------
1 | # Configuration Guides
2 | 
3 | * [How to build projects with Jenkins](https://github.com/so87/Home-Lab/blob/master/Jenkins%20Build.md)
4 | * [Configure Jenkins/Git](https://github.com/so87/Home-Lab/blob/master/Jenkins%20and%20Git%20Config)
5 | * [Jenkins/Mocha Security Testing](https://github.com/so87/Home-Lab/blob/master/Jenkins%20and%20Mocha%20Security%20Testing)
6 | 


--------------------------------------------------------------------------------
/Jenkins Build.md:
--------------------------------------------------------------------------------
 1 | # How to build projects with Jenkins
 2 | Need to download plugins for sonarqube, docker, ssh, badges, and github
 3 | 
 4 | ## Make ssh key for jenkins machine
 5 | 
 6 | Navigate to the below area on github and create an SSH key for your jenkins machine.  This is 
 7 | so jenkins can push dev code to production.
 8 | <p align="center">
 9 |   <img width="400" height="500" src="https://github.com/so87/Home-Lab/blob/master/pics/git%20ssh%20keys.png">
10 | </p>
11 | 
12 | ## Setup jenkins bulid to poll github for events, scan with sonarqube, and deploy
13 | 
14 | ### Pull code from repository
15 | <p align="center">
16 |   <img width="760" height="760" src="https://github.com/so87/Home-Lab/blob/master/pics/source%20code%20management.png">
17 | </p>
18 | 
19 | ### Trigger the build after a commit has been pushed to github
20 | <p align="center">
21 |   <img width="760" height="760" src="https://github.com/so87/Home-Lab/blob/master/pics/build%20trigger%20and%20env.png">
22 | </p>
23 | 
24 | ### Nightly jenkins event
25 | <p align="center">
26 |   <img width="760" height="560" src="https://github.com/so87/Home-Lab/blob/master/pics/nightly%20%20build.png">
27 | </p>
28 | 
29 | ### Deploy containers
30 | <p align="center">
31 |   <img width="760" height="500" src="https://github.com/so87/Home-Lab/blob/master/pics/deploy.png">
32 | </p>
33 | 
34 | ### Destroy containers
35 | <p align="center">
36 |   <img width="760" height="500" src="https://github.com/so87/Home-Lab/blob/master/pics/destroy%20containers.png">
37 | </p>
38 | 
39 | ### Push the results back to production
40 | <p align="center">
41 |   <img width="760" height="760" src="https://github.com/so87/Home-Lab/blob/master/pics/push%20to%20git.png">
42 | </p>
43 | 
44 | <p align="center">
45 |   <img width="760" height="760" src="https://github.com/so87/Home-Lab/blob/master/pics/git%20settings.png">
46 | </p>
47 | 


--------------------------------------------------------------------------------
/Jenkins and Git Config:
--------------------------------------------------------------------------------
1 | # Jenkins/Git Integration
2 | https://docs.bitnami.com/aws/how-to/create-ci-pipeline/
3 | turn off "allow requests to the local network from hooks and services" in github if you are pulling from local github
4 | 
5 | 


--------------------------------------------------------------------------------
/Jenkins and Mocha Security Testing:
--------------------------------------------------------------------------------
1 | # Jenkins/Mocha Security Testing
2 | 1. Downloading practice
3 | 
4 | 
5 | 2. Writing a test
6 | 
7 | 
8 | 3. Adding to build
9 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | <p align="center">
 2 |   <img width="460" height="300" src="https://images-na.ssl-images-amazon.com/images/I/51SoJzZvfLL._SX258_BO1,204,203,200_.jpg">
 3 | </p>
 4 | 
 5 | # Home Lab
 6 | This repository holds the documentation for my home lab I've built up and guides for others wanting
 7 | to build their own home network. Building your own home network is the best way to learn and can be
 8 | much cheaper than you think.
 9 | 
10 | 
11 | ### Network Diagram
12 | This is my current network configuration.  I used Visio to create the diagram.
13 | [NETWORK DIAGRAM](https://github.com/so87/Home-Lab/blob/master/simon%20network.pdf).
14 | 
15 | ### Software Development Excellence
16 | The best thing about having all of this equipment is being able to deliver high quality software.  Every piece of software I write goes through my own Jenkins pipeline.  This pipeline runs static code analysis tests to reduce the amount of bugs, vulnerabilities, and technical debt.  I also write my own mocha security tests with Mocha to ensure my architecture is secure.  Once all of these tests pass, the code gets merged into production, and automatically deployed.  See the diagram.
17 |   [CODING PROCESS](https://github.com/so87/Home-Lab/blob/master/development-pipeline.pdf).
18 | #### Deployment Process
19 | <p align="center">
20 |   <img width="1000" height="500" src="https://github.com/so87/Security-Lab-Manager/blob/dev/documentation/dev-deploy-process.PNG">
21 | </p
22 | If you like this and want to setup your own build and code scanning stack head with https certs look at my other [repository](https://github.com/so87/CI-CD-Secure-Pipeline)
23 | 
24 | ### My Hardware
25 | Below is the hardware I use to run my home network.  My network works great for my needs, 
26 | but by no means could support several users.  Building a network for enterprise use is a different beast.
27 | Define what you need and want from your home lab before even thinking about buying hardware. Do lots of research. Many hardware buying guides from bloggers and streamers spend way too much money.  For example, if you are only going to store
28 | files and host your own website, it makes no sense to spend $3,000 on a server with 52 GB of RAM. 
29 | It's tempting to buy the latest and greatest hardware.  Always: 1.Ready  2.Aim  3.Fire
30 | 
31 | Networking Equipment
32 | 
33 | | Function             | Name                       | Cost $  |
34 | | -------------        |:-------------:             | -----:  |
35 | | Router/Firewall      | Unifi USG                  | 112     |
36 | | Switch               | Unifi 8 port POE Switch    | 102     |
37 | | Wifi                 | Unifi UAC Pro              | 120     |
38 | | Rack/Rails/Shelves   | 18U 19"                    | 170     |
39 | 
40 | Server
41 | 
42 | | Function             | Name                       | Cost $  |
43 | | -------------        |:-------------:             | -----:  |
44 | | Server               | HP DL 380 G7               | 100     |
45 | | RAM                  | DDR3 SRAM 8GB x 6          | 16      |
46 | | CPU                  | Xeon E5645 2.4 Ghz x 2     | 16      |
47 | | Hard Drives          | 10 K SAS HP 300GB x 6      | 20      |
48 | | External Storage     | 8TB Seagate                | 120     |
49 | | UPS                  | Tripp Lite 1500VA          | 160     |
50 | 
51 | Wifi Hacking Practice
52 | 
53 | | Function             | Name                       | Cost $  |
54 | | -------------        |:-------------:             | -----:  |
55 | | Router/Wifi          | Netgear WNR1000v2          | 30     |
56 | | Wifi Hacking Adapter | ALFA Networks AWUS036H USB 500mW    | 20     |
57 | | Victum Computer      | Dell 8GB 2.4 Gz Win 7      | 0     |
58 | 
59 | 
60 | ### Configuration Guides(in progress)
61 | [LINK](https://github.com/so87/Home-Lab/blob/master/Configuration%20Guides.md)
62 | 
63 | ### Buying a Server and Hardware buying guide
64 |  Use this [LINK](https://www.labgopher.com/) to buy servers.  It filters ebay for servers based on your inputs. <br />
65 |  Reddit also has a great write-up for getting started <br />
66 |  [Reddit Guide](https://www.reddit.com/r/homelab/wiki/buyingguide)
67 |  
68 |  Here is a great guide for making your own home NAS <br />
69 |  [DIY NAS](https://blog.briancmoses.com/2017/03/diy-nas-2017-edition.html) 
70 | 
71 | # Community
72 | This is a really great community for seeing what others do.  Great resource for building your
73 | own homelab.  Becareful browsing this sub-reddit too much... it may make you buy expensive equipment. <br />
74 | [Reddit Home Lab](https://www.reddit.com/r/homelab/)
75 | 


--------------------------------------------------------------------------------
/cheat:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env bash
  2 | # Author: Alexander Epstein https://github.com/alexanderepstein
  3 | 
  4 | currentVersion="1.22.0"
  5 | configuredClient=""
  6 | ## rest of these variables are search flags
  7 | search="0"
  8 | insensitive=""
  9 | recursive=""
 10 | boundry=""
 11 | 
 12 | ## This function determines which http get tool the system has installed and returns an error if there isnt one
 13 | getConfiguredClient()
 14 | {
 15 |   if  command -v curl &>/dev/null; then
 16 |     configuredClient="curl"
 17 |   elif command -v wget &>/dev/null; then
 18 |     configuredClient="wget"
 19 |   elif command -v http &>/dev/null; then
 20 |     configuredClient="httpie"
 21 |   elif command -v fetch &>/dev/null; then
 22 |     configuredClient="fetch"
 23 |   else
 24 |     echo "Error: This tool reqires either curl, wget, httpie or fetch to be installed." >&2
 25 |     return 1
 26 |   fi
 27 | }
 28 | 
 29 | ## Allows to call the users configured client without if statements everywhere
 30 | httpGet()
 31 | {
 32 |   case "$configuredClient" in
 33 |     curl)  curl -A curl -s "$@" ;;
 34 |     wget)  wget -qO- "$@" ;;
 35 |     httpie) http -b GET "$@" ;;
 36 |     fetch) fetch -q "$@" ;;
 37 |   esac
 38 | }
 39 | 
 40 | 
 41 | checkInternet()
 42 | {
 43 |   httpGet github.com > /dev/null 2>&1 || { echo "Error: no active internet connection" >&2; return 1; } # query github with a get request
 44 | }
 45 | 
 46 | update()
 47 | {
 48 |   # Author: Alexander Epstein https://github.com/alexanderepstein
 49 |   # Update utility version 2.2.0
 50 |   # To test the tool enter in the defualt values that are in the examples for each variable
 51 |   repositoryName="Bash-Snippets" #Name of repostiory to be updated ex. Sandman-Lite
 52 |   githubUserName="alexanderepstein" #username that hosts the repostiory ex. alexanderepstein
 53 |   nameOfInstallFile="install.sh" # change this if the installer file has a different name be sure to include file extension if there is one
 54 |   latestVersion=$(httpGet https://api.github.com/repos/$githubUserName/$repositoryName/tags | grep -Eo '"name":.*?[^\\]",'| head -1 | grep -Eo "[0-9.]+" ) #always grabs the tag without the v option
 55 | 
 56 |   if [[ $currentVersion == "" || $repositoryName == "" || $githubUserName == "" || $nameOfInstallFile == "" ]]; then
 57 |     echo "Error: update utility has not been configured correctly." >&2
 58 |     exit 1
 59 |   elif [[ $latestVersion == "" ]]; then
 60 |     echo "Error: no active internet connection" >&2
 61 |     exit 1
 62 |   else
 63 |     if [[ "$latestVersion" != "$currentVersion" ]]; then
 64 |       echo "Version $latestVersion available"
 65 |       echo -n "Do you wish to update $repositoryName [Y/n]: "
 66 |       read -r answer
 67 |       if [[ "$answer" == [Yy] ]]; then
 68 |         cd ~ || { echo 'Update Failed'; exit 1; }
 69 |         if [[ -d  ~/$repositoryName ]]; then rm -r -f $repositoryName || { echo "Permissions Error: try running the update as sudo"; exit 1; } ; fi
 70 |         echo -n "Downloading latest version of: $repositoryName."
 71 |         git clone -q "https://github.com/$githubUserName/$repositoryName" && touch .BSnippetsHiddenFile || { echo "Failure!"; exit 1; } &
 72 |         while [ ! -f .BSnippetsHiddenFile ]; do { echo -n "."; sleep 2; };done
 73 |         rm -f .BSnippetsHiddenFile
 74 |         echo "Success!"
 75 |         cd $repositoryName || { echo 'Update Failed'; exit 1; }
 76 |         git checkout "v$latestVersion" 2> /dev/null || git checkout "$latestVersion" 2> /dev/null || echo "Couldn't git checkout to stable release, updating to latest commit."
 77 |         chmod a+x install.sh #this might be necessary in your case but wasnt in mine.
 78 |         ./$nameOfInstallFile "update" || exit 1
 79 |         cd ..
 80 |         rm -r -f $repositoryName || { echo "Permissions Error: update succesfull but cannot delete temp files located at ~/$repositoryName delete this directory with sudo"; exit 1; }
 81 |       else
 82 |         exit 1
 83 |       fi
 84 |     else
 85 |       echo "$repositoryName is already the latest version"
 86 |     fi
 87 |   fi
 88 | }
 89 | 
 90 | usage()
 91 | {
 92 | cat <<EOF
 93 | Cheat
 94 | Description: Cheatsheets for quick information about multiple programming languages along with terminal commands
 95 | Usage: cheat [flags] [command] or cheat [flags] [programming language] [subject]
 96 |   -s  Does a search for last argument rather than looking for exact match
 97 |   -i  Case insensitive search
 98 |   -b  Word boundaries in search
 99 |   -r  Recursive search
100 |   -u  Update Bash-Snippet Tools
101 |   -h  Show the help
102 |   -v  Get the tool version
103 | Special Pages:
104 |   hello      Describes building the hello world program written in the language
105 |   list       This lists all cheatsheets related to previous arg if none it lists all cheatsheets
106 |   learn      Shows a learn-x-in-minutes language cheat sheet perfect for getting started with the language
107 |   1line      A collection of one-liners in this language
108 |   weirdness  A collection of examples of weird things in this language
109 | Examples:
110 |   cheat rust hello
111 |   cheat -r -b -i go
112 |   cheat julia Functions
113 |   cheat -i go operators
114 | EOF
115 | }
116 | 
117 | getCheatSheet()
118 | {
119 |   if [[ $# == 1 ]]; then
120 |     if [[ $search == "1" ]]; then
121 |       link=cheat.sh/~$1
122 |     else
123 |       link=cheat.sh/$1
124 |     fi
125 |   else
126 |     link=cheat.sh/$1
127 |   fi
128 | 
129 |   if [[ $# == 2 ]]; then
130 |     if [[ $search == "1" ]]; then
131 |       link+=/~$2 ## add this to end of link where ~ indicates search
132 |     else
133 |       link+=/$2 ## add this to end of link
134 |     fi
135 |   fi
136 | 
137 |   if [[ $insensitive != "" || $recursive != "" || $boundry != "" ]]; then link+=/$boundry$insensitive$recursive; fi ## add this to the end of the link as flags
138 | 
139 |   httpGet $link
140 | }
141 | 
142 | 
143 | ### This function just wraps some of the special pages provided by cheat.sh
144 | checkSpecialPage()
145 | {
146 |   temp=$1
147 |   if [[ $1 == "list" ]]; then
148 |     temp=":list"
149 |   elif [[ $1 == "learn" ]]; then
150 |     temp=":list"
151 |   elif [[ $1 == "styles" ]]; then
152 |     temp=":styles"
153 |   fi
154 |   if [[ $2 == "1" ]]; then
155 |     arg1=$temp
156 |   else
157 |     arg2=$temp
158 |   fi
159 | }
160 | 
161 | getConfiguredClient || exit 1
162 | 
163 | 
164 | while getopts "ribuvhis" opt; do
165 |   case "$opt" in
166 |     \?) echo "Invalid option: -$OPTARG" >&2
167 |         exit 1
168 |         ;;
169 |     h)  usage
170 |         exit 0
171 |         ;;
172 |     v)  echo "Version $currentVersion"
173 |         exit 0
174 |         ;;
175 |     u)
176 |         checkInternet || exit 1
177 |         update
178 |         exit 0
179 |         ;;
180 |     i)  insensitive="i"
181 |         search="1"
182 |         ;;
183 |     b)  boundry="b"
184 |         search="1"
185 |         ;;
186 |     r)  recursive="r"
187 |         search="1"
188 |         ;;
189 |     s)  search="1"
190 |         ;;
191 |     :)  echo "Option -$OPTARG requires an argument." >&2
192 |         exit 1
193 |         ;;
194 |   esac
195 | done
196 | 
197 | ### This functions sets arg 1 and arg 2 to be unqique items after the options
198 | for arg; do
199 |   if [[ $arg != "-r" && $arg != "-s" && $arg != "-b" && $arg != "-i" ]]; then
200 |     if [ -z ${arg1+x} ]; then
201 |       arg1=$arg
202 |     fi
203 |     if [ ! -z ${arg1+x} ]; then
204 |       arg2=$arg
205 |     fi
206 |   fi
207 | done
208 | 
209 | ## check for special pages before moving on
210 | checkSpecialPage $arg1 1
211 | checkSpecialPage $arg2 2
212 | 
213 | if [[ $# == 0 ]]; then
214 |   usage
215 |   exit 0
216 | elif [[ $1 == "update" ]]; then
217 |   checkInternet || exit 1
218 |   update
219 |   exit 0
220 | elif [[ $1 == "help" || $1 == ":help" ]]; then ## shows the help and prevents the user from seeing cheat.sh/:help
221 |   usage
222 |   exit 0
223 | else
224 |   checkInternet || exit 1
225 |   if [[ $arg1 != $arg2 ]]; then ## if they equal each other that means there was no arg 2 supplied
226 |     getCheatSheet $arg1 $arg2
227 |     exit 0
228 |   else
229 |     getCheatSheet $arg1
230 |     exit 0
231 |   fi
232 |   exit 0
233 | fi
234 | 


--------------------------------------------------------------------------------
/development-pipeline.pdf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/so87/Home-Lab/1f7734efefa3c571b0234a7764d1125c719bbae4/development-pipeline.pdf


--------------------------------------------------------------------------------
/pics/build trigger and env.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/so87/Home-Lab/1f7734efefa3c571b0234a7764d1125c719bbae4/pics/build trigger and env.png


--------------------------------------------------------------------------------
/pics/deploy.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/so87/Home-Lab/1f7734efefa3c571b0234a7764d1125c719bbae4/pics/deploy.png


--------------------------------------------------------------------------------
/pics/destroy containers.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/so87/Home-Lab/1f7734efefa3c571b0234a7764d1125c719bbae4/pics/destroy containers.png


--------------------------------------------------------------------------------
/pics/git settings.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/so87/Home-Lab/1f7734efefa3c571b0234a7764d1125c719bbae4/pics/git settings.png


--------------------------------------------------------------------------------
/pics/git ssh keys.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/so87/Home-Lab/1f7734efefa3c571b0234a7764d1125c719bbae4/pics/git ssh keys.png


--------------------------------------------------------------------------------
/pics/nightly  build.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/so87/Home-Lab/1f7734efefa3c571b0234a7764d1125c719bbae4/pics/nightly  build.png


--------------------------------------------------------------------------------
/pics/push to git.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/so87/Home-Lab/1f7734efefa3c571b0234a7764d1125c719bbae4/pics/push to git.png


--------------------------------------------------------------------------------
/pics/source code management.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/so87/Home-Lab/1f7734efefa3c571b0234a7764d1125c719bbae4/pics/source code management.png


--------------------------------------------------------------------------------
/simon network.pdf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/so87/Home-Lab/1f7734efefa3c571b0234a7764d1125c719bbae4/simon network.pdf


--------------------------------------------------------------------------------