Skip to content

Commit

Permalink
README.md: Add improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
gustafla committed Dec 14, 2024
1 parent 4fd2fdb commit a55e648
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,27 @@ https://github.com/user-attachments/assets/7330d8de-9707-465b-840f-c8a18cb829f2
Fall 2024, Group 11

This repository contains a distributed DHCP server with shared state and a CLI for testing the server.
A DHCP Relay Agent, acting as a load balancer, has been designed but not implemented.
A DHCP Relay Agent, acting as a load balancer, has been designed but **not implemented**.

The software is currently _prototype quality_, it's not intended for production use.
The software is currently **prototype quality**, it's not intended for production use.

### Features:
- Written in Rust, blazingly fast :fire:
- Multithreaded :rocket:
- Shared state (all nodes know all leases)
- Fault tolerance via redundancy
- Leader election with bully algorithm
- Leader decides which node gets to give offers from which part of the address pool
- Custom protocol, **does not actually implement DHCP** ([yet](https://github.com/hy-ds-group-11/dhcpcluster/issues/4))
- Probably not completely reliable, but it's just DHCP
- No `async` (for no particular reason)

## Documentation

[Design document :paperclip:](doc/design.md)

[Server documentation :books:](https://hy-ds-group-11.github.io/dhcpcluster/server_node/index.html)

[Client-server protocol documentation :books:](https://hy-ds-group-11.github.io/dhcpcluster/protocol/index.html)

### Weekly notes :notebook_with_decorative_cover:

| Week | Summary |
Expand All @@ -32,6 +41,6 @@ The software is currently _prototype quality_, it's not intended for production
| [49](doc/week49.md) | :1234::computer: Leader election, address pool distribution, client CLI |
| [50](doc/week50.md) | :sparkles: DHCP functionality and client-server communication |

## Downloads
## Downloads :floppy_disk:

[See: Releases](https://github.com/hy-ds-group-11/dhcpcluster/releases)
[See Releases](https://github.com/hy-ds-group-11/dhcpcluster/releases)

0 comments on commit a55e648

Please sign in to comment.