README.md 2.22 KB
Newer Older
Attila Farkas's avatar
Attila Farkas committed
1
# Sandbox Creator
Jan Vykopal's avatar
Jan Vykopal committed
2

Attila Farkas's avatar
Attila Farkas committed
3
Sandbox creator is a tool, which can generate portable input files for building lightweight virtual environments using Vagrant and Ansible from a simple YAML definition of topology. The combination of these three tools makes possible to build virtual machines connected with virtual networks even on a desktop computer.
Attila Farkas's avatar
Attila Farkas committed
4

Attila Farkas's avatar
Attila Farkas committed
5
This project is the next generation of [KYPO Creator](https://gitlab.ics.muni.cz/KYPO-content/KYPO-Creator).
Attila Farkas's avatar
Attila Farkas committed
6

Attila Farkas's avatar
Attila Farkas committed
7
## Installation
Attila Farkas's avatar
Attila Farkas committed
8

Attila Farkas's avatar
Attila Farkas committed
9
**Note:** This is just a quick guide how to install and generate files with this tool. For full describtion of how to prepare the host device to be able run the generated environments and how to build the virtual machines check our [wiki page](https://gitlab.ics.muni.cz/cs4eu/sandbox-creator/-/wikis/Installation-and-Usage).
Attila Farkas's avatar
Attila Farkas committed
10

Attila Farkas's avatar
Attila Farkas committed
11
### Linux Mint
Attila Farkas's avatar
Attila Farkas committed
12
13
14
15
16
17
18
19

1. Install git using the command `$ sudo apt-get install git`.
2. Clone the project with `$ git clone https://gitlab.ics.muni.cz/cs4eu/sandbox-creator.git` to an arbitrary directory.
3. Navigate to the project directory (`$ cd sandbox-creator`).
4. Install pip using `$ sudo apt-get install python3-pip`.
5. Install setuptools with `$ pip3 install setuptools`.
6. Install dependencies with the command `$ pip3 install -r requirements.txt`.

Attila Farkas's avatar
Attila Farkas committed
20
### Windows 10
Attila Farkas's avatar
Attila Farkas committed
21
22
23
24

1. Install [Python 3](https://www.python.org/downloads/windows/). At the beginning of the installation mark the "Add Python to PATH" option.
2. Install [git](https://git-scm.com/downloads).
3. Clone the project with `git clone https://gitlab.ics.muni.cz/cs4eu/sandbox-creator.git` to an arbitrary folder.
Attila Farkas's avatar
Attila Farkas committed
25
26
4. Navigate to the project folder (`cd sandbox-creator`).
5. Install Python dependencies using the command `python -m pip install -r .\requirements.txt`.
Attila Farkas's avatar
Attila Farkas committed
27

Attila Farkas's avatar
Attila Farkas committed
28
## Usage
Attila Farkas's avatar
Attila Farkas committed
29

Attila Farkas's avatar
Attila Farkas committed
30
### Linux Mint
Attila Farkas's avatar
Attila Farkas committed
31

Attila Farkas's avatar
Attila Farkas committed
32
After the installation simply run the command `$ python3 create.py sandbox.yml` to generate the files.
Attila Farkas's avatar
Attila Farkas committed
33

Attila Farkas's avatar
Attila Farkas committed
34
### Windows 10
Attila Farkas's avatar
Attila Farkas committed
35

Attila Farkas's avatar
Attila Farkas committed
36
Generate the files using the command `python create.py -l sandbox.yml`.
Attila Farkas's avatar
Attila Farkas committed
37

Attila Farkas's avatar
Attila Farkas committed
38
## Credits
Attila Farkas's avatar
Attila Farkas committed
39

Attila Farkas's avatar
Attila Farkas committed
40
41
**Cybersecurity laboratory**\
**Faculty of Informatics**\
Attila Farkas's avatar
Attila Farkas committed
42
**Masaryk University**
Attila Farkas's avatar
Attila Farkas committed
43

Attila Farkas's avatar
Attila Farkas committed
44
**Lead developer**: Attila Farkas
Attila Farkas's avatar
Attila Farkas committed
45

Attila Farkas's avatar
Attila Farkas committed
46
**Technology lead**: Daniel Tovarňák (KYPO cyber range platform)
Attila Farkas's avatar
Attila Farkas committed
47

Attila Farkas's avatar
Attila Farkas committed
48
**Supervisor**: Jan Vykopal
Jan Vykopal's avatar
Jan Vykopal committed
49

Attila Farkas's avatar
Attila Farkas committed
50
**Contributors**:
Jan Vykopal's avatar
Jan Vykopal committed
51

Attila Farkas's avatar
Attila Farkas committed
52
53
54
55
- Valdemar Švábenský
- Michal Staník
- Zdeněk Vydra
- Adam Skrášek
Jan Vykopal's avatar
Jan Vykopal committed
56

Attila Farkas's avatar
Attila Farkas committed
57
## License