Skip to content

User Guide

BitK edited this page Jun 9, 2021 · 4 revisions

Tutorial / User Guide

Table of Contents

Docker

Overview

This tab give you a global view of your different Docker images, which one works with others, how they are connected, etc.

Images

PwnMachine allows to search Docker images directly from Docker Hub by their name. Once the Docker image is found, you can simply click on the button PULL to start to pull this image on PwnMachine.

You can also update an existent Docker images by clicking on the button UPDATE.

Tags & options

You can add a tags on each images by clicking on image. Details of the configuration are also displayed in the same time.

Containers

From your Docker images, you can create a new container based on your images previously pulled. Use the list to select your image and define settings. You have the possibility to start automatically the container once options are saved by selecting Start the container.

Networks

Volumes

DNS

DNS Zone

The application allows to define a new DNS Zone to set your own DNS records. The DNS Zone creation defines a SOA records to set the primary name server, the email of the domain administrator, the domain serial number, and several timers relating to refreshing the zone.

DNS Server configuration

To allow the application to configure the DNS records with it, you need to configure the DNS server at your cloud hosting. To do this, configure a new DNS zone example.com. on the application with a nameserver equivalent to ns.example.com..

From your cloud hosting, you can then configure the DNS server used as ns.example.com. and the IP of the machine.

DNS Rules

Spoiler Alert : When you set a new record, don't forget to press Enter key to set it.

  • Define IPv4 :

    • Name = example.com.
    • Type = A
    • Record = 127.0.0.1
  • Subdomain :

    • Name = www.example.com.
    • Type = CNAME
    • Record = example.com.
  • Namespace :

    • Name = example.com.
    • Type = NS
    • Record = ns.example.com.
  • Email :

    • Name = example.com.
    • Type = MX
    • Record = 10 mail.example.com.

Traefik

Traefik

Traefik is an Edge Router, it means that it's the door to your platform, and that it intercepts and routes every incoming request: it knows all the logic and every rule that determine which services handle which requests (based on the path, the host, headers, and so on ...).

Pwn-machine try to do a one-to-one mapping of traefik configuration. Pwn-machine use redis as a database to store traefik configuration. This allow you to update almost any settings without the need to restart treafik.

By default traefik will listen on TCP port 80 and 443.

Overview

This tab give you a global view of the configuration of traefik.

Entrypoints

Entrypoints

EntryPoints are the network entry points into Traefik. They define the port which will receive the packets, and whether to listen for TCP or UDP.

Routers

Routers

A router is in charge of connecting incoming requests to the services that can handle them. In the process, routers may use pieces of middleware to update the request, or act before forwarding the request to the service.

Middlewares

Middlewares

Attached to the routers, pieces of middleware are a means of tweaking the requests before they are sent to your service (or before the answer from the services are sent to the clients).

Services

Services

The Services are responsible for configuring how to reach the actual services that will eventually handle the incoming requests.