https://github.com/cbeck88/deqs-demo-package
A package builder for deqs deployment
https://github.com/cbeck88/deqs-demo-package
Last synced: 3 months ago
JSON representation
A package builder for deqs deployment
- Host: GitHub
- URL: https://github.com/cbeck88/deqs-demo-package
- Owner: cbeck88
- Created: 2023-04-07T18:23:03.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2025-02-17T01:27:15.000Z (4 months ago)
- Last Synced: 2025-03-20T04:12:49.837Z (3 months ago)
- Language: Shell
- Size: 24.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# deqs-demo-package
This repo helps you set up a minimal deployment of the deqs.
## Quick start
Start by getting a cloud machine somewhere.
I used [Amazon Lightsail](https://aws.amazon.com/free/compute/lightsail/?trk=56417dfe-8849-4622-bfa4-7ec30bd6f5a3&sc_channel=ps&ef_id=Cj0KCQjw_r6hBhDdARIsAMIDhV9mF7D1mX0JVrE8kVXF_gKbQw3GOy8Prk3Bc6AtwPdOZHMYgTAY3t4aAgMyEALw_wcB:G:s&s_kwcid=AL!4422!3!536323500429!e!!g!!amazon%20lightsail!11199789546!116615087504) with 4 GB RAM, 2 vCPUs, 80 GB SSD.
I configured a machine with OS-only and selected Ubuntu 24.04.
I use the following startup script:
```
apt update && apt install supervisor jq wget -y
cd /
curl -s https://api.github.com/repos/cbeck88/deqs-demo-package/releases/latest | jq -r '.assets[] | select(.name=="package_mainnet.tar.gz") | .browser_download_url' | wget -i -
tar -xzvf package-mainnet.tar.gz
supervisorctl reload
```
This uses `wget` to fetch the pre-created package and unpack it over root with `tar`.
(You can replace `package-mainnet` with `package-testnet` to deploy the test-net build and config instead.)
If you prefer, you can skip the startup script and run those commands manually after `sudo su` in the vm.
---
To check if the deployment worked, get a shell on the vm, and run `supervisorctl`.
To monitor the services using `supervisorctl`, you can use the commands `status` and `tail -f mobilecoind` or `tail -f deqs` to look at logs.
You can also `stop` and `start` the services using `supervisorctl`.
Use `help` to see all the available `supervisorctl` commands.
You can also look at the `/var/log/mobilecoind.log` and `/var/log/deqs.log` files on disk, outside of `supervisorctl`.
## Ports and Networking
With the packaged configs, the deqs is started without TLS, listening on port 7000.
* This is `insecure-deqs://` scheme.
* You can modify `/etc/supervisord/conf.d/deqs.conf` if you want to change how it is launched.
I recommend that you
1. Click on the networking tab and configure a static ip.
1. Add a firewall rule allowing custom protocols to make TCP connections on port 7000.
If you have a static ip, you can set up an A record in DNS if you like.
## Testing that it is working
You can go to the deqs repository (or submodule of this repo) and run the test-cli.
```
./deqs-test-cli get-quotes --deqs-uri insecure-deqs://123.456.789.000
```
## Building the package manually
To build the package, start by checking out this repo and building the rust part.
First set `NETWORK` to either `prod` or `test`, for a mainnet or testnet build.
```
git submodule update --recursive
./build_rust.sh
```
Then you can build the package, which produces `package.tar.gz`.
```
./make_package.sh
```
If you want to make a new release, simply tag whatever changes you made and attach `package.tar.gz` to the release.