Skip to content

Commit 6a54cd8

Browse files
author
elreydetoda
authored
Install methods (#7)
* adding meta readme * listing meta readme * adding easy install method * adding medium install method * adding advanced install method * adding about bash aliases * telling users how to connect to vm * added todo for linking url for advanced issue * added how to enumerate aliases
1 parent 7d7c8b9 commit 6a54cd8

5 files changed

Lines changed: 67 additions & 2 deletions

File tree

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@ stay tuned to our [YouTube](https://www.youtube.com/user/secureideas) and [Twitt
66

77
## Pre-reqs
88

9-
- need >= bash 4.4, because of [`mapfile`](https://unix.stackexchange.com/questions/482358/does-readarray-allow-to-specify-line-delimiter#answer-482366)
10-
- note: I will be using the latest version of the [docker bash container](https://hub.docker.com/_/bash)
119
- [vagrant](https://vagrantup.com/)
1210
- install instructions [here](https://github.com/SamuraiWTF/samuraiwtf#vagrant)
1311
- a hypervisor that is supported by [this box](https://app.vagrantup.com/bento/boxes/ubuntu-20.04)
1412
- note: I will be using virtualbox
13+
14+
## Install
15+
16+
All possible/recommended install methods are [here](/install_methods/)

install_methods/00/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Easy Install Method
2+
3+
## Install
4+
5+
1. make sure you have the [pre-reqs](/README.md#pre-reqs)
6+
2. then you can download the zip of the [latest release][repo_latest_url]
7+
3. open up a cli prompt into the new downloaded and unzip directory
8+
4. run `vagrant up`
9+
5. once the machine is setup (i.e. finshed provisioning), then you can run `vagrant ssh`
10+
11+
[repo_latest_url]: https://github.com/ProfessionallyEvil/bash_tricks/releases/latest

install_methods/01/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Medium Install Method
2+
3+
## Install
4+
5+
1. make sure you have the [pre-reqs](/README.md#pre-reqs)
6+
<!-- added the url twice, in case if the first link wasn't obvious -->
7+
2. download the raw [`Vagrantfile`][raw_vagrantfile_url] from [here][raw_vagrantfile_url]
8+
3. run `vagrant up`
9+
4. once the machine is setup (i.e. finshed provisioning), then you can run `vagrant ssh`
10+
11+
[raw_vagrantfile_url]: https://raw.githubusercontent.com/ProfessionallyEvil/bash_tricks/master/Vagrantfile

install_methods/02/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Advanced Install Method
2+
3+
## Info
4+
5+
Doesn't matter how you get it, but no matter what you need >= bash 4.4, because of [`mapfile`](https://unix.stackexchange.com/questions/482358/does-readarray-allow-to-specify-line-delimiter#answer-482366)
6+
7+
note: I will be using the latest version of the [docker bash container](https://hub.docker.com/_/bash)
8+
9+
You can either use a *nix machine/environment, a vagrant box you declare ([mine](/Vagrantfile) will work as well, since it is ubuntu 20.04), or the aformentioned docker container.
10+
11+
## Warning
12+
13+
If you choose this install method I will **NOT** support it, because there is too many things that can vary between different *nix environments.
14+
15+
### Caveat
16+
17+
<!-- TODO: issue #5: add link for the advanced type of issue that they can submit once templates are created -->
18+
If there is something that should work based on what you can deduce and there is a problem (maybe with what is supported in your current bash version), feel free to submit an issue but it will be marked wontfix, unless I decide to investigate more and change the label because it is interesting to me. 😁

install_methods/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Install Methods
2+
3+
## Methods
4+
5+
These are a few ways you can follow along with this video series.
6+
7+
- [First method](./00/) - this is probably the easiest for people that are new
8+
- [Second method](./01/) - this is still decently easy, just involves a bit of cli work
9+
- [Third method](./02/) - this is only if you are fairly aquainted with docker and/or vagrant
10+
11+
## Note
12+
13+
If you choose either the first or second method you will get some additional niceties that I have baked into the virtual machine's (vm's) setup through bash aliases.
14+
15+
### Niceties
16+
17+
I have created a few bash aliases to help aid in running docker.
18+
19+
1. `pe-bash` - this will the main location we will be playing around with things.
20+
- what is this: it is a bash alias that handles connecting to docker and mounting things you will need access to do all the bash tricks.
21+
2. `pe-cleanup` - this is used to remove the previously created container in case you are having issues with your environment. You can then run the `pe-bash` command afterwards to re-setup your environment.
22+
23+
Any other aliases I create, and might not have documented will be prepended with `pe-`, so to enumerate them you can type `pe-` and then hit the `<TAB>` key. That will try and tab complete anything in your path that starts with `pe-`.

0 commit comments

Comments
 (0)