From 866e1dcb9bd93ddc520424a5549ae6081fef5a3f Mon Sep 17 00:00:00 2001 From: tracer Date: Tue, 1 Mar 2022 19:45:32 +0100 Subject: [PATCH] more text, one more screenshot. Signed-off-by: tracer --- README.md | 33 ++++++++++++++++++--------------- 1 file changed, 18 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index acbb952..b74734d 100644 --- a/README.md +++ b/README.md @@ -43,15 +43,12 @@ The CLI is used to perform configuration and some checks: ![OpenAPI](https://bindapi.24unix.net/assets/bindAPI_api1.png) -The APi is a RESTful API, there is a self explaining Swagger/OpenAPI available. - - +The API is a RESTful API, there is a self explaining Swagger/OpenAPI available. # 3. Installation -You can install the bindAPi on either a standalone server or an existing KeyHelp Panel. -However, slave zones are only managed for masters which lie on Keyhelp panels. +You can install the bindAPI on either a standalone server or an existing KeyHelp Panel. However, slave zones are only managed for masters which lie on Keyhelp panels. ## 3.1. Installation on a KeyHelp panel @@ -115,7 +112,13 @@ Remove the defaults files: `rm *` -Next, we'll need to fetch the bindAPI (currently it has no release tag, that will change later) +Next, we'll need to fetch the bindAPI. As of now, the latest release is 1.0.1: +https://git.24unix.net/tracer/bindAPI/archive/1.0.1.tar.gz + +I'd suggest checking here for the latest version: +https://git.24unix.net/tracer/bindAPI/releases + +Or just use git to checkout the latest update: ``` git clone https://git.24unix.net/tracer/bindAPI.git @@ -132,11 +135,11 @@ We need to pull the dependencies for composer: `/usr/bin/keyhelp-php81 /usr/local/bin/composer update` -You might notice a quite strange command. -We need to call php with full path, and explicitly the 8.1 version. -KeyHelp relies on the default PHP installation, so the php binary will always point to 7.4 when your on Debian Bullseye. +You might notice a quite strange command. We need to call php with full path, and explicitly the 8.1 version. KeyHelp +relies on the default PHP installation, so the php binary will always point to 7.4 when you're on Debian Bullseye. -So, in bin/console the path to /usr/bin/keyhelp-php81 is hardcoded after the shebang, a step we have to remind if we install the standalone version. +So, in bin/console the path to /usr/bin/keyhelp-php81 is hardcoded after the shebang, a step we have to remind if we +install the standalone version. Now make the CLI executable: @@ -151,19 +154,19 @@ Should I create a new config based on config.json.sample? (y/N): n You first have to setup the bindAPI. Bye. ``` -So now we can head back to our panel and set the Document root to -/home/users/tfunix/ns1.24unix.net/bindAPI/public. +So now we can head back to our panel and set the Document root to /home/users/tfunix/ns1.24unix.net/bindAPI/public. Additionally, we have to change the open_basedir directive: -##DOCROOT##/www:##DOCROOT##/files:##DOCROOT##/tmp:/etc/bind:/etc/bind/local.zones -TODO: Screenshot +`##DOCROOT##/www:##DOCROOT##/files:##DOCROOT##/tmp:/etc/bind:/etc/bind/local.zones` + +![Php Interpreter](https://bindapi.24unix.net/assets/bindAPI_phpsetting.png) and remove exec from disabled functions. OK, we are finished with the installation and head over to the [4. Configuration](#4-configuration). -## 3.2. Installation on a plain debian Bullseye +## 3.2. Installation on a plain Debian Bullseye So, at first you should read and understand all steps in 3.1, as we will learn only the differences.