2023-01-29 20:09:00 +00:00
# ServNest
2021-03-04 00:02:50 +00:00
2023-01-29 20:09:00 +00:00
ServNest (formerly Niver) is software providing a web interface allowing users to manage 3 independent services:
2021-03-04 00:02:50 +00:00
2022-10-12 22:39:59 +00:00
* Public suffix registry
2023-01-29 20:09:00 +00:00
* Domain name server
2022-10-12 22:39:59 +00:00
* Static HTTP site hosting
2021-03-04 00:02:50 +00:00
2022-11-20 00:24:54 +00:00
## Status
2023-01-29 20:09:00 +00:00
I plan to create and maintain a public stable instance of ServNest, but I haven't done so yet. Thus it is not yet tested with real world and long-term usages, and is **alpha software** .
2022-11-20 00:24:54 +00:00
2023-01-29 20:09:00 +00:00
## Detailed services features
2022-10-12 22:39:59 +00:00
### Public suffix registry (`reg`)
* Register a subdomain of the registry
* Set domain's nameservers
* Set a DS record to enable DNSSEC
* Set Glue records
2023-05-02 15:34:40 +00:00
* Display records
2023-01-29 20:09:00 +00:00
* Transfer domain to another account
2022-10-12 22:39:59 +00:00
2023-01-29 20:09:00 +00:00
### Name server (`ns`)
2022-10-12 22:39:59 +00:00
* Host a zone on the server
2023-06-15 01:35:42 +00:00
* Plain zone file edition
2022-10-12 22:39:59 +00:00
* Dedicated forms to set/unset `A` , `AAAA` , `NS` , `TXT` , `CAA` , `SRV` , `MX` , `SRV` , `SSHFP` , `TLSA` , `CNAME` , `DNAME` and `LOC` records
2023-05-02 15:34:40 +00:00
* Display records or the full zone file
2022-10-12 22:39:59 +00:00
2023-01-29 20:09:00 +00:00
### Static HTTP site hosting (`ht`)
Upload site's files to the server using SFTP. The way the site is accessed can then be choosed:
2022-10-12 22:39:59 +00:00
2023-01-29 20:09:00 +00:00
* Dedicated domain name and Let's Encrypt certificate
* Dedicated onion service (through Tor)
* Subdomain of a shared root domain
* HTTP subpath of a shared domain
2022-10-12 22:39:59 +00:00
2023-05-02 15:34:40 +00:00
Some Apache configuration directives are available through `.htaccess` .
2023-04-23 14:36:41 +00:00
2022-10-12 22:39:59 +00:00
## Software used
[PHP ](https://www.php.net/ )
: main language
[SQLite ](https://www.sqlite.org/index.html )
: accounts data storage
[Knot DNS ](https://www.knot-dns.cz/ )
: DNS server for both registry and DNS hosting
[sudo ](https://www.sudo.ws/ ) 1.9.10+
: execute actions that match a regex as privileged or specific users
2022-11-23 21:21:34 +00:00
[SFTPGo ](https://github.com/drakkan/sftpgo )
2022-10-12 22:39:59 +00:00
: upload sites files using SFTP
2023-04-09 22:50:42 +00:00
[Apache HTTP Server ](https://httpd.apache.org/ )
: static HTTP server, with content negotiation and `.htaccess` dynamic configuration
2022-10-12 22:39:59 +00:00
[nginx ](https://nginx.org/ )
2023-04-23 14:36:41 +00:00
: HTTP reverse proxy for Apache; terminates TLS and enforces security headers
2022-10-12 22:39:59 +00:00
Tor
: [Onion services ](https://community.torproject.org/onion-services/ )
[Certbot ](https://certbot.eff.org/ )
: get [Let's Encrypt ](https://letsencrypt.org/ ) certificates for TLS
2023-05-02 15:34:40 +00:00
[GNU Core Utilities ](https://www.gnu.org/software/coreutils/ ) or [BusyBox ](https://www.busybox.net/ )
2022-10-12 22:39:59 +00:00
: manipulate the filesystem through sudo
## Installation
2023-05-02 15:34:40 +00:00
Manual installation instructions can be found in [DOCS/installation.md ](DOCS/installation.md ).
[servnest-mkosi ](https://code.antopie.org/servnest/servnest-mkosi ) can automatically build a system image for ServNest and has configuration files and scripts.
2022-10-12 22:39:59 +00:00
## Contribute
2023-01-29 20:09:00 +00:00
- Git repository : < https: // code . antopie . org / servnest / servnest >
- Issue tracker : < https: // code . antopie . org / servnest / servnest / issues >
- Matrix channel : [#servnest:matrix.antopie.org ](matrix:r/servnest:matrix.antopie.org )
2022-10-12 22:39:59 +00:00
## Direct contact details
See < https: / / miraty . antopie . org / > .
2022-08-29 17:19:13 +00:00
## License
2023-01-29 20:09:00 +00:00
ServNest is ethical libre software: you can use, redistribute or modify it under the terms of the CNPL-NAv7+ as found in LICENSE.md or at < https: / / git . pixie . town / thufie / npl-builder > .
2023-01-07 22:12:53 +00:00
## Similar projects
- [DNSManager ](https://github.com/KaneRoot/dnsmanager ) powering [netlib.re ](https://netlib.re/ )
- [EU.org ](https://nic.eu.org/ )
- [DNS Witch ](https://dns-witch.net.eu.org/ )