Compare commits
3 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 09b6a832ee | |||
| e95acbd4f2 | |||
| 47c570c44d |
38
README.md
38
README.md
@@ -1,9 +1,25 @@
|
||||
# DECNET
|
||||
<div align="center">
|
||||
|
||||
A honeypot deception network framework. Spin up a fleet of fake machines — called **deckies** — that appear as real, heterogeneous LAN hosts to anyone scanning the network. Each decky gets its own MAC address, IP, hostname, services, OS fingerprint, and log pipeline. Attackers probe the network, DECNET traps every interaction, and a full intelligence stack profiles, clusters, and attributes their behaviour.
|
||||
<img src="assets/decnet-logo.svg" alt="DECNET — Deception Network" width="560">
|
||||
|
||||
**A honeypot deception network framework.**
|
||||
|
||||
Spin up a fleet of fake machines — **deckies** — that look like real, heterogeneous LAN hosts to anyone scanning the network. Each decky gets its own MAC, IP, hostname, services, OS fingerprint, and log pipeline. Attackers probe; DECNET traps every interaction; a full intelligence stack profiles, clusters, and attributes their behaviour.
|
||||
|
||||
<br>
|
||||
|
||||
[](https://pypi.org/project/decnet/)
|
||||
[](https://pypi.org/project/decnet/)
|
||||
[](LICENSE)
|
||||
[](https://github.com/astral-sh/ruff)
|
||||
[](#requirements)
|
||||
|
||||
[Quick Start](#quick-start) · [Architecture](#architecture) · [REST API](#rest-api--web-dashboard) · [MazeNET](#mazenet-topology) · [Support](https://ko-fi.com/C0C31YDLB5)
|
||||
|
||||
[](https://ko-fi.com/C0C31YDLB5)
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## Table of Contents
|
||||
@@ -120,11 +136,20 @@ sudo decnet deploy --mode unihost --deckies 5 --interface eth0 --randomize-servi
|
||||
|
||||
### Start the API server and web dashboard
|
||||
|
||||
Recommended (systemd-managed):
|
||||
|
||||
```bash
|
||||
sudo .venv/bin/decnet init # first-time setup: writes systemd units
|
||||
sudo systemctl start "decnet-*.service" # start all DECNET services
|
||||
```
|
||||
|
||||
For development / quick runs, start the processes directly in the foreground:
|
||||
|
||||
```bash
|
||||
decnet api start # REST API on :8000
|
||||
decnet web start # Dashboard on :8080
|
||||
```
|
||||
|
||||
### Check status
|
||||
|
||||
```bash
|
||||
@@ -270,12 +295,21 @@ The full command tree has grown significantly. Commands are gated by deployment
|
||||
|
||||
### Start
|
||||
|
||||
Recommended (systemd-managed):
|
||||
|
||||
```bash
|
||||
cp .env.example .env.local # edit JWT secret, ports, DB backend
|
||||
sudo .venv/bin/decnet init # writes systemd units
|
||||
sudo systemctl start "decnet-*.service" # starts API, workers, bus
|
||||
```
|
||||
|
||||
For development / quick runs, start the processes directly in the foreground:
|
||||
|
||||
```bash
|
||||
decnet api start # :8000
|
||||
decnet web start # :8080
|
||||
```
|
||||
|
||||
### Authentication
|
||||
|
||||
All API endpoints (except `POST /api/v1/auth/login`) require a JWT bearer token. The health endpoint returns 401 without a token; liveness probes should accept 401 as healthy.
|
||||
|
||||
6
assets/decnet-logo.svg
Normal file
6
assets/decnet-logo.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 10 KiB |
Reference in New Issue
Block a user