No description

Find a file

Mael GRAMAIN 1b00ac0528 Clarification of config example Since the SQL database port is 3306, the type should be set as "mysql".		2020-12-27 21:18:01 -04:00
.github/workflows	Github renamed master branch to main...	2020-12-13 20:22:11 -04:00
core	Using api structs for the Records	2020-12-27 20:34:26 -04:00
extra	Clarification of config example	2020-12-27 21:18:01 -04:00
utils	Using api structs for the Records	2020-12-27 20:34:26 -04:00
.deepsource.toml	Add .deepsource.toml	2020-12-13 18:33:16 +00:00
.gitignore	add built binary to gitignore	2020-12-25 02:33:41 +01:00
go.mod	Using api structs for the Records	2020-12-27 20:34:26 -04:00
go.sum	Using api structs for the Records	2020-12-27 20:34:26 -04:00
LICENCE	Licence added	2020-12-13 15:16:24 -04:00
main.go	Format code with gofmt	2020-12-24 01:45:10 +00:00
Makefile	Service file	2020-12-13 21:05:00 -04:00
README.md	updated README.md	2020-12-25 03:16:09 +01:00

Sacrebleu

Sacrebleu is a DNS authoritative nameserver made in Go with github.com/miekg/dns library.

Records are stored in a SQL Database and cached using Redis.

This software requires a SQL server and a Redis server.

This software is currently in development and NOT ready for production.

Installation

Each release contains a RPM and DEB package.

Download the latest package compatible with your system
Edit the config file in /etc/sacrebleu/config-dns.ini
Launch the database migration with sacrebleu-dns -sqlmigrate -config /etc/sacrebleu/config-dns.ini
Start the service systemctl start sacrebleu-dns

Download the latest release compatible with your system
Download and edit the configuration file
Launch the database migration with sacrebleu-dns -sqlmigrate -config [config path].ini
Download and edit the systemd service and put it in /lib/systemd/system/
Start the service systemctl start sacrebleu-dns

You can show theses informations using ./sacrebleu-dns -h.

   -config string
        the patch to the config file (default "extra/config.ini.example")
  -sqlmigrate
        initialize / migrate the database

Variables names are case sensitives.

Variable name	Type	Example	Informations
app_mode	string	`"production"`	Anything different than `production` will show debug messages
App	Section
IP	string	`":"`	IP address on which the DNS server must listen. Blank to listen on all IPs
Port	int	`5353`	Port on which the DNS server must listen
Logfile	bool	`true`	Enable or disable file logs.
Database	Section
Type	string	`"postgresql"`	SQL Database type. `"postgresql"` or `"mysql"` (anything different than `"postgresql"` will rollback to `"mysql"`)
Host	string	`"127.0.0.1"` `"/var/run/postgres"`	Can be either an IP or a path to a socket for Postgres
Username	string	`"sacrebleu"`	SQL Database Username
Password	string	`"superSecretPassword"`	SQL Database Password (optional)
Port	string	`"5432"`	SQL Database port (`"5432"` for postgres or `"3306"` for MySQL by default)
Db	string	`"sacrebleudatabase"`	SQL Database Name
Redis	Section
IP	string	`"127.0.0.1"`	Redis Database IP
Password	string	`""`	Redis Database Password
Port	int	`6379`	Redis Database port
DB	int	`0`	Redis Database ID
TTL	int	`10`	Redis Time To Live (in seconds)