web/README.md
2022-11-10 11:56:06 +00:00

76 lines
2 KiB
Markdown

![fwlnx](https://gitlab.com/fwlnx/fwlnx/-/raw/master/fwlnx.png)
# fwlnx
Firewall Linux - A small and simple Linux based Firewall Distribution
It combines a smart Linux distribution ([NixOS](https://nixos.org/)) with modern network services, a simple web interface and API to configure it. It's not meant to be a replacement to far superiour Appliances like [pfSense](https://www.pfsense.org/) or [OPNSense](https://opnsense.org/) but as an alternative solution for typical home use.
## Target platforms
- QEMU/KVM
- [PCEngines APU2/3/4](https://www.pcengines.ch/apu2.htm)
- Generic [AliExpress](https://www.aliexpress.com/wholesale?catId=0&SearchText=router+pc) Router PCs
## Planned initial features
- Firewall ([netfilter](https://netfilter.org/))
- [ ] NAT
- [ ] Rules
- [ ] UPnP ([miniupnp](https://miniupnp.tuxfamily.org/))
- [ ] DynDNS ([ddclient](https://ddclient.net/))
- VPN
- [ ] [OpenVPN](https://openvpn.net/)
- [ ] [Wireguard](https://www.wireguard.com/)
- [ ] NTP ([chrony](https://chrony.tuxfamily.org/))
- [ ] DHCP ([Kea](https://www.isc.org/kea/))
- [ ] DNS ([Knot](https://www.knot-dns.cz/))
- [ ] TFTP ([Netkit TFTP](http://ftp.linux.org.uk/pub/linux/Networking/netkit/))
- [ ] Auto config backup
- [ ] Cron/Timers ([Systemd-timers](https://www.freedesktop.org/software/systemd/man/systemd.timer.html))
## Installation
TBD
## Design
### Partitioning
The partitioning schema is kept simple and will be setup like this:
BIOS/MBR:
```
/dev/sda:
/dev/sda1 swap [SWAP] # SWAP
/dev/sda2 ext4 / # FWLNX
```
UEFI/GPT:
```
/dev/sda:
/dev/sda1 vfat /boot # ESP
/dev/sda2 swap [SWAP] # SWAP
/dev/sda3 ext4 / # FWLNX
```
### Operating system
As the base operating system NixOS is used.
### [Garmr](https://gitlab.com/fwlnx/garmr)
Backend daemon
### [Freyja](https://gitlab.com/fwlnx/freyja)
Web frontend
---
Made with ❤️ and 🪄✨.
Icon partly from [stockio](https://www.stockio.com/free-icon/nature-icons-penguin)