Configure and run the TDEX box easily using Terraform automation.
As a first step it is required to obtain AWS access and secret keys. Best practice is to create a new user in AWS IAM. Please navigate to Services > IAM page > Add user. Open the AWS IAM users page, and click on Add user. Provide user with name and select Programmatic access on the Access type section.
Next, make sure that your AWS account (access key) has all the required privileges to create EC2 instances and S3 access. Permissions you need: EC2 full, S3 full and VPC access.
Once you add Permissions and Tags, click Create user. That will bring you to the latest page provided with AWS Access and Secret Keys. Copy your keys to a safe place and do not share them with anyone.
Check the documentation here
Next step is to install Terraform on your machine. The easiest way is to follow the official documentation here. For Debian and Ubuntu APT Packages, you can also follow this installation.
$ curl -fsSL https://apt.releases.hashicorp.com/gpg | sudo apt-key add -$ sudo apt-add-repository "deb [arch=$(dpkg --print-architecture)] https://apt.releases.hashicorp.com $(lsb_release -cs) main"$ sudo apt install terraform
Clone the TDEX Box repository and enter its directory.
git clone https://github.com/tdex-network/tdex-box.gitcd tdex-box
On the AWS AMI Marketplace, find Ubuntu 20.04 public AMI, accessible in the region you are planing to deploy the service and copy its AMI ID.
Once you have everything in place, just execute deploy.sh and it will prompt you for all the parameters in the same order provided above. Since it is good practice to have a backup enabled, please provide S3 bucket a name when deploying. Please enter the parameters carefully.
Make sure you copy the IP address after the deployment is over. This is your TDEX endpoint IP, and it can be accessed over port 9000.
$ cd terabox/$ chmod +x deploy.sh$ ./deploy.sh
When executing deploy.sh, you can also setup your service behind Tor. You can provide your own V3 Onion private key, or simply leave it empty in order to have the service to generate it for you.
Connect to your Linux box over SSH and get onion endpoint.
$ ssh -i ~/.ssh/key_location [email protected]$ docker exec tor onions
TDEX is a CLI (GRPC client), that can be used to interact with a remote TDEX-daemon endpoint. We need to init/configure tdex-cli, which is a way of authenticating to the remote running deamon. When configuring the service, we need to provide several things:
- rpcserver (this will be IP of machine where tdex-box is deployed)
To install TDEX CLI you need to run getCli.sh located in scripts folder. If installed successfully tdex-cli will print help menu.
$ chmod +x terabox/scripts/getCli.sh$ sudo ./terabox/scripts/getCli.sh
Once you have installed tdex-cli, you will need to download the TLS certificate and macaroons from your tdexd host machine in order to connect remotely. This command will download the whole tdexd/ folder which is a copy of your container deamon.
$ scp -r [email protected]:$HOME/tdex-box/tdexd .
Configure the tdex-cli with downloaded macaroons and certificate, and add your remote endpoint IP.
- cert.pem is located at $HOME/tdex-box/tdexd/tls/cert.pem on the remote machine
- admin.macaroon is located at $HOME/tdex-box/tdexd/macaroons/admin.macaroon on the remote machine
# By default it looks for the daemon operator gRPC interface on localhost:9000# or on a remote machine$ tdex config init --rpcserver=tdex.remote.host.ip:9000 --tls_cert_path=./cert.pem --macaroons_path=./admin.macaroon##### OR you can use the config command to set your values$ tdex config$ tdex config set tls_cert_path ./cert.pem$ tdex config set macaroons_path ./admin.macaroon$ tdex config set rpcserver tdex.remote.host.ip
After those are set, you can test the TDEX daemon$ tdex listmarket$ tdex help <-- for more information and commands
For more information how to configure and use the TDEX CLI
Done! Now you are ready to deposit funds to open a market and earn swap fees.