README.md 1.98 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 to 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
## Table of Contents
Attila Farkas's avatar
Attila Farkas committed
8

Attila Farkas's avatar
Attila Farkas committed
9
[[_TOC_]]
10

Attila Farkas's avatar
Attila Farkas committed
11
----
Attila Farkas's avatar
Attila Farkas committed
12

Attila Farkas's avatar
Attila Farkas committed
13
## Installation
Attila Farkas's avatar
Attila Farkas committed
14

Attila Farkas's avatar
Attila Farkas committed
15
### Linux Mint
Attila Farkas's avatar
Attila Farkas committed
16
17
18
19
20
21
22
23

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
24
### Windows 10
Attila Farkas's avatar
Attila Farkas committed
25
26
27
28

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
29
30
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
31

Attila Farkas's avatar
Attila Farkas committed
32
----
Attila Farkas's avatar
Attila Farkas committed
33

Attila Farkas's avatar
Attila Farkas committed
34
## Usage
Attila Farkas's avatar
Attila Farkas committed
35

Attila Farkas's avatar
Attila Farkas committed
36
### Linux Mint
Attila Farkas's avatar
Attila Farkas committed
37

Attila Farkas's avatar
Attila Farkas committed
38
After the installation simply run the command `$ python3 create.py sandbox.yml` to generate the files.[^1],[^2]
Attila Farkas's avatar
Attila Farkas committed
39

Attila Farkas's avatar
Attila Farkas committed
40
### Windows 10
Attila Farkas's avatar
Attila Farkas committed
41

Attila Farkas's avatar
Attila Farkas committed
42
Generate the files using the command `python create.py -l sandbox.yml`.[^1],[^2]
Attila Farkas's avatar
Attila Farkas committed
43

Attila Farkas's avatar
Attila Farkas committed
44
----
Attila Farkas's avatar
Attila Farkas committed
45

Attila Farkas's avatar
Attila Farkas committed
46
## Credits
Attila Farkas's avatar
Attila Farkas committed
47

Attila Farkas's avatar
Attila Farkas committed
48
49
50
**Cybersecurity laboratory**\
**Faculty of Informatics**\
**Masaryk University**\
Attila Farkas's avatar
Attila Farkas committed
51

Attila Farkas's avatar
Attila Farkas committed
52
**Lead developer**: Attila Farkas
Attila Farkas's avatar
Attila Farkas committed
53

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

Attila Farkas's avatar
Attila Farkas committed
56
**Supervisor**: Jan Vykopal
Jan Vykopal's avatar
Jan Vykopal committed
57

Attila Farkas's avatar
Attila Farkas committed
58
**Contributors**:
Jan Vykopal's avatar
Jan Vykopal committed
59

Attila Farkas's avatar
Attila Farkas committed
60
61
62
63
- Valdemar Švábenský
- Michal Staník
- Zdeněk Vydra
- Adam Skrášek
Jan Vykopal's avatar
Jan Vykopal committed
64

Attila Farkas's avatar
Attila Farkas committed
65
----
Jan Vykopal's avatar
Jan Vykopal committed
66

Attila Farkas's avatar
Attila Farkas committed
67
## License
Jan Vykopal's avatar
Jan Vykopal committed
68

Attila Farkas's avatar
Attila Farkas committed
69
----