Go to file
tracer c347368fa2 typo
Signed-off-by: tracer <tracer@24unix.net>
2022-02-19 19:03:33 +01:00
.idea updates .idea-settings 2022-02-05 20:27:31 +01:00
bin added config.json.local 2022-02-12 19:39:05 +01:00
public changed parameter names 2022-02-19 18:25:07 +01:00
src added error check on domain creation 2022-02-13 16:35:38 +01:00
tests added Logger and config 2022-02-06 17:41:04 +01:00
.gitignore added local copy of swagger-ui 2022-02-05 20:25:26 +01:00
README.md typo 2022-02-19 19:03:33 +01:00
composer.json added name and author 2022-02-12 19:39:47 +01:00
composer.lock upgraded composer requirenments 2022-02-06 19:14:06 +01:00
config.json.sample clenaed dir tree 2022-01-24 13:31:35 +01:00
log.txt changed setup 2022-01-25 20:51:12 +01:00
phpunit.xml added swaggerui 2022-02-05 20:26:32 +01:00

README.md

  1. Overview
  2. Features
  3. Installation
  4. Configuration
  5. The API
  6. Conclusion

Overview

This package provides an API for the Bind nameserver. It consists of two parts, the API itself and a CLI tool to configure the available functions.

Features

CLI

Php Interpreter

The CLI is used to perform configuration and some checks:

  • check
    • Permissions: The API needs to be able to access some files and create new ones
    • Panels: This checks one or all panels if every nameserver is aware of all domains
    • Domain: TODO
  • panels
    • List: List all panels which are configured on this server
    • Create: Adds a new panel to the configuration
    • Update: Changes one or more parameters of the panel
    • Delete: Deletes the given panel
    • ApiPing: Calls the /ping endpoint of the given server
    • some additional API call might be added
  • nameservers
    • similar to panels, but for the nameservers
  • domains
    • similar usage to panels/domains, manage all slave zones
  • apikeys
    • manage the keys to access this nameserver via API

API

Installation

Configuration

The API

Conclusion

In KeyHelp, install PHP 8.1

Settings => Configuration => Feature Settings => PHP Interpreter Php Interpreter

Php Interpreter

Php Interpreter

Php Interpreter

Set the checkmark and press Save.

Wait about a minute, the installation is started via a cronjob which runs every minute.

As root (or via sudo):

apt install git

Creat a new user for the domain, adn then a new domain, e.g. ns3.24unix.net.

Set the PHP Version to 8.1: