Skip to content

Commit

Permalink
* start of INSTALL.md
Browse files Browse the repository at this point in the history
  • Loading branch information
johanix committed Sep 4, 2024
1 parent b2e7b0f commit 3e17094
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 3 deletions.
19 changes: 19 additions & 0 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
### TAPIR-POP INSTALLATION

TAPIR-POP is usually installed as a Docker container, but it can also be run as a separate binary.
This document focuses on the latter alternative.

## Building TAPIR-POP

## Configuring TAPIR-POP

By default, TAPIR-POP will look for a configuration files in the directory `/etc/dnstapir`. The primary configuration file is `/etc/dnstapir/tapir-pop.yaml`. If the file is not found, the program will terminate with an error.

## Connecting TAPIR-POP to TAPIR-CORE

The primary requisite is a client certificate and key for the TAPIR-POP server issued by the TAPIR-CORE CA. To obtain these, run the script
`generate-csr.sh` and follow the instructions. The script is only a few lines long and is easy to follow. It takes one parameter, which is a TAPIR "instance id". This is needed to ensure that the CSR is unique.

The result is a file named `tapir-instance-id.csr` and a file named `tapir-instance-id.key`. The CSR file is sent manually to the TAPIR-CORE for signing and in return the TAPIR-CORE will return a signed certificate in a file named `tapir-instance-id.crt`.

The next step is to configure TAPIR-POP with the location of the TAPIR-CORE server, the CA certificate, and the signed certificate. This is done with the `tapir-pop.toml` configuration file.
5 changes: 2 additions & 3 deletions generate-csr.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,13 @@

if [ $# != 1 ]; then
echo Usage: $0 instance-id
echo \"instance-id\" is a string that you choose yourself that will identify this DNS TAPIR Edge instance.
echo A domain name is usually a good idea.
echo \"instance-id\" is a string that you receive from TAPIR Core that will identify this DNS TAPIR Edge instance.
exit 1
fi

id=$1

echo Your chosen DNS TAPIR Edge Id is \"$id\".
echo Your DNS TAPIR Edge Id is \"$id\".
/bin/echo -n "Proceed [yes]: "
default_ans="yes"
read answer
Expand Down

0 comments on commit 3e17094

Please sign in to comment.