updated README.md

This commit is contained in:
vorband 2015-03-05 08:36:59 +01:00
parent 6751a9ad97
commit 815a716d19

View file

@ -1,16 +1,44 @@
tpotce # T-Pot Community Edition Image Creator
======
T-Pot Community Edition Image Creator This repository contains the necessary files to create the **[T-Pot community honeypot](http://dtag-dev-sec.github.io/)** ISO image.
The image can then be used to install T-Pot on a physical or virtual machine.
Requirements: ### Image Creation
**Requirements to create the ISO image:**
- Ubuntu 14.04.2 or 14.10 as host system (others *may* work, but remain untested)
- 2GB of free memory
- 4GB of free storage
- Ubuntu 14.04.2 or 14.10 (on Mac e.g. use Vagrant to run a virtual environment) **How to create the ISO image:**
- Depending on your installed distribution (desktop vs. server) you should have at least 2GB of free memory and 4GB of free storage before executing the script.
1. Clone the repository and enter it.
git clone git@github.com:dtag-dev-sec/tpotce.git
cd tpotce
2. Invoke the script that builds the ISO image.
The script will download and install dependecies necessary to build the image on the invoking machine. It will further download the ubuntu base image (~600MB) which T-Pot is based on.
sudo ./makeiso.sh
After successful build, you will find the ISO image `tpotce.iso` in your directory.
Credentials: ###Prebuilt ISO Image
If you don't want to build the image yourself, you can download the prebuilt [tpotce.iso](http://dtag-dev-sec.github.io/tpotce.iso) ISO image from the project's web page.
user: tsec ###Installation
pass: tsec When installing the T-Pot ISO image, make sure the target system (physical/virtual) meets the following minimal requirements:
- 2 GB RAM (4 GB recommended)
- 40 GB disk (64 GB SSD recommended)
- Network via DHCP
The installation requires very little interaction. Most things should be configured automatically. The system will reboot a couple of times. Make sure it can access the internet as it needs to download the dockerized honeypot components. Depending on your network connection, the installation may take some time.
Once the installation is finished, the system will automatically reboot and you will be presented with a login screen. The user credentials for the first login are:
- user: tsec
- pass: tsec
You will need to set a new password after first login.
All honeypot services are started automatically.
For further information and a more in depth installation instruction, visit [T-Pot's website](http://dtag-dev-sec.github.io/).