36 lines
		
	
	
	
		
			1.5 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
			
		
		
	
	
			36 lines
		
	
	
	
		
			1.5 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
### Quick Start
 | 
						|
 | 
						|
To install and test this application, you'll need:
 | 
						|
- both **purs** and **spago** binaries, in order to compile this purescript application;
 | 
						|
- both [authd][authd] and [dnsmanagerd][dnsmanagerd], in order to use this dnsmanager webclient with its related services, and they both require [libipc][libipc];
 | 
						|
- (optional) a http server to serve the website and its documentation (such as darkhttpd, which is used in the makefile).
 | 
						|
 | 
						|
To compile this purescript application:
 | 
						|
```sh
 | 
						|
make
 | 
						|
```
 | 
						|
 | 
						|
### Introduction
 | 
						|
 | 
						|
`dnsmanager-webclient` is the official interface for [dnsmanager][dnsmanagerd],
 | 
						|
the software being the [net libre][netlibre] service which provides free domain names.
 | 
						|
 | 
						|
This web application is fully written in [PureScript][purescript] with the [Halogen][halogen] library and using the [Bulma][bulma] CSS library.
 | 
						|
 | 
						|
This web application provides a simple user interface to manage DNS zones with many types of DNS resources:
 | 
						|
- basic entries such as: A, AAAA, NS, CNAME, TXT, SRV
 | 
						|
- mail-related entries: MX, SPF, DKIM, DMARC
 | 
						|
- CAA
 | 
						|
 | 
						|
### Status
 | 
						|
 | 
						|
This web application is already deployed on [the netlibre website][netlibre].
 | 
						|
However, there is still room for improvement, see TODO.md.
 | 
						|
 | 
						|
[authd]: https://git.baguette.netlib.re/Baguette/authd
 | 
						|
[dnsmanagerd]: https://git.baguette.netlib.re/Baguette/dnsmanager
 | 
						|
[libipc]: https://git.baguette.netlib.re/Baguette/libipc
 | 
						|
[netlibre]: https://netlib.re/
 | 
						|
[purescript]: https://www.purescript.org/
 | 
						|
[halogen]: https://github.com/purescript-halogen/purescript-halogen/
 | 
						|
[bulma]: https://bulma.io/
 |