servnest/README.md

# ServNest

ServNest (formerly Niver) is software allowing users to manage 3 independent services:

* Public suffix registry
* Domain name server
* Static HTTP site hosting

## Status

ServNest is alpha software.

Proper versioning, changelog and upgrade/migration instructions are still missing.

[https://niver.niv.re/](Niver) is an installation administrated by the main developer.

## Detailed services features

### Public suffix registry (`reg`)

* Register a subdomain of the registry
* Set domain's nameservers
* Set a DS record to enable DNSSEC
* Set Glue records
* Display records
* Transfer domain to another account
* Partial `CSYNC` and `CDS` support to synchronize from child zone

### Name server (`ns`)

* Host a zone on the server
* Plain zone file edition
* Dedicated forms to set/unset `A`, `AAAA`, `NS`, `TXT`, `CAA`, `SRV`, `MX`, `SRV`, `SSHFP`, `TLSA`, `CNAME`, `DNAME` and `LOC` records
* Display records or the full zone file
* Keep records in sync with another domain (`CNAME` alternative for apex domains)

### Static HTTP site hosting (`ht`)

Upload site's files to the server using SFTP. The way the site is accessed can then be choosed:

* 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

Some Apache configuration directives are available through `.htaccess`.

## 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

[SFTPGo](https://github.com/drakkan/sftpgo)
: upload sites files using SFTP

[Apache HTTP Server](https://httpd.apache.org/)
: static HTTP server, with content negotiation and `.htaccess` dynamic configuration

[nginx](https://nginx.org/)
: HTTP reverse proxy for Apache; terminates TLS and enforces security headers

Tor
: [Onion services](https://community.torproject.org/onion-services/)

[Certbot](https://certbot.eff.org/)
: get [Let's Encrypt](https://letsencrypt.org/) certificates for TLS

Cronie (or another cron daemon)
: periodically run script to sync registry records with child zones and pseudo-CNAMEs at apex

[GNU Core Utilities](https://www.gnu.org/software/coreutils/) or [BusyBox](https://www.busybox.net/)
: manipulate the filesystem through sudo

## Installation

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.

## Resources

[Matrix room](matrix:r/servnest:matrix.antopie.org) (`#servnest:matrix.antopie.org`)
: english/french
: discuss, get help and organise contribution

[Issue tracker](https://code.antopie.org/servnest/servnest/issues)
: english
: keep track of bugs et wanted features

[Git repository](https://code.antopie.org/servnest/servnest)
: english
: code, administration documentation

## Direct contact details

Find them on [https://miraty.antopie.org/](my site).

## License

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>.

## Somehow similar projects

[DNSManager](https://github.com/KaneRoot/dnsmanager):
: domain registry powering [netlib.re](https://netlib.re/)

[EU.org](https://nic.eu.org/)
: domain registry

[DNS Witch](https://dns-witch.net.eu.org/)
: user-friendly domain hosting based on EU.org

[Codeberg Pages](https://codeberg.page/)
: static website hosting published through Git

[Njalla](https://njal.la/)
: anonymous domain registrar
Niver > ServNest 2023-01-29 20:09:00 +00:00			`# ServNest`
Add README 2021-03-04 00:02:50 +00:00
update readme 2023-10-29 13:12:28 +00:00			`ServNest (formerly Niver) is software allowing users to manage 3 independent services:`
Add README 2021-03-04 00:02:50 +00:00
Detailed README 2022-10-12 22:39:59 +00:00			`* Public suffix registry`
Niver > ServNest 2023-01-29 20:09:00 +00:00			`* Domain name server`
Detailed README 2022-10-12 22:39:59 +00:00			`* Static HTTP site hosting`
Add README 2021-03-04 00:02:50 +00:00
readme: Add status information 2022-11-20 00:24:54 +00:00			`## Status`

update readme 2023-10-29 13:12:28 +00:00			`ServNest is alpha software.`

			`Proper versioning, changelog and upgrade/migration instructions are still missing.`

			`[https://niver.niv.re/](Niver) is an installation administrated by the main developer.`
readme: Add status information 2022-11-20 00:24:54 +00:00
Niver > ServNest 2023-01-29 20:09:00 +00:00			`## Detailed services features`
Detailed README 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`
Add installation instructions 2023-05-02 15:34:40 +00:00			`* Display records`
Niver > ServNest 2023-01-29 20:09:00 +00:00			`* Transfer domain to another account`
update readme 2023-10-29 13:12:28 +00:00			* Partial `CSYNC` and `CDS` support to synchronize from child zone
Detailed README 2022-10-12 22:39:59 +00:00
Niver > ServNest 2023-01-29 20:09:00 +00:00			### Name server (`ns`)
Detailed README 2022-10-12 22:39:59 +00:00
			`* Host a zone on the server`
Allow SSH keys authentication for SFTP(Go) 2023-06-15 01:35:42 +00:00			`* Plain zone file edition`
Detailed README 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
Add installation instructions 2023-05-02 15:34:40 +00:00			`* Display records or the full zone file`
update readme 2023-10-29 13:12:28 +00:00			* Keep records in sync with another domain (`CNAME` alternative for apex domains)
Detailed README 2022-10-12 22:39:59 +00:00
Niver > ServNest 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:`
Detailed README 2022-10-12 22:39:59 +00:00
Niver > ServNest 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`
Detailed README 2022-10-12 22:39:59 +00:00
Add installation instructions 2023-05-02 15:34:40 +00:00			Some Apache configuration directives are available through `.htaccess`.
Fix exec()'s $output 2023-04-23 14:36:41 +00:00
Detailed README 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`

Make services reloading systemd-agnostic 2022-11-23 21:21:34 +00:00			`[SFTPGo](https://github.com/drakkan/sftpgo)`
Detailed README 2022-10-12 22:39:59 +00:00			`: upload sites files using SFTP`

Use Apache - Allows customization through .htaccess - No need to configure or reload a server when adding a site - Content negotiation 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

Detailed README 2022-10-12 22:39:59 +00:00			`[nginx](https://nginx.org/)`
Fix exec()'s $output 2023-04-23 14:36:41 +00:00			`: HTTP reverse proxy for Apache; terminates TLS and enforces security headers`
Detailed README 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`

Add instructions for cron(ie) setup 2023-09-01 00:20:09 +00:00			`Cronie (or another cron daemon)`
			`: periodically run script to sync registry records with child zones and pseudo-CNAMEs at apex`

Add installation instructions 2023-05-02 15:34:40 +00:00			`[GNU Core Utilities](https://www.gnu.org/software/coreutils/) or [BusyBox](https://www.busybox.net/)`
Detailed README 2022-10-12 22:39:59 +00:00			`: manipulate the filesystem through sudo`

			`## Installation`

update readme 2023-10-29 13:12:28 +00:00			Manual installation instructions can be found in [`DOCS/installation.md`](DOCS/installation.md).
Add installation instructions 2023-05-02 15:34:40 +00:00
			`[servnest-mkosi](https://code.antopie.org/servnest/servnest-mkosi) can automatically build a system image for ServNest and has configuration files and scripts.`
Detailed README 2022-10-12 22:39:59 +00:00
update readme 2023-10-29 13:12:28 +00:00			`## Resources`

			[Matrix room](matrix:r/servnest:matrix.antopie.org) (`#servnest:matrix.antopie.org`)
			`: english/french`
			`: discuss, get help and organise contribution`

			`[Issue tracker](https://code.antopie.org/servnest/servnest/issues)`
			`: english`
			`: keep track of bugs et wanted features`
Detailed README 2022-10-12 22:39:59 +00:00
update readme 2023-10-29 13:12:28 +00:00			`[Git repository](https://code.antopie.org/servnest/servnest)`
			`: english`
			`: code, administration documentation`
Detailed README 2022-10-12 22:39:59 +00:00
			`## Direct contact details`

update readme 2023-10-29 13:12:28 +00:00			`Find them on [https://miraty.antopie.org/](my site).`
Set CNPLv7+ as license 2022-08-29 17:19:13 +00:00
			`## License`

Niver > ServNest 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>.`
readme: delete Todo, add Similar projects 2023-01-07 22:12:53 +00:00
update readme 2023-10-29 13:12:28 +00:00			`## Somehow similar projects`

			`[DNSManager](https://github.com/KaneRoot/dnsmanager):`
			`: domain registry powering [netlib.re](https://netlib.re/)`

			`[EU.org](https://nic.eu.org/)`
			`: domain registry`

			`[DNS Witch](https://dns-witch.net.eu.org/)`
			`: user-friendly domain hosting based on EU.org`

			`[Codeberg Pages](https://codeberg.page/)`
			`: static website hosting published through Git`
readme: delete Todo, add Similar projects 2023-01-07 22:12:53 +00:00
update readme 2023-10-29 13:12:28 +00:00			`[Njalla](https://njal.la/)`
			`: anonymous domain registrar`