Update 'README.md' #1

Theo · 2022-11-09T02:09:02+03:00

Theo commented

2022-11-09 02:09:02 +03:00

Add comprehensive instructions on how to setup a Relayer with NGINX and Docker Compose.

Theo commented

2023-01-20 19:13:54 +03:00

This has been a long-needed improvement in documentation for the relayer process, however trying to follow the guide to test the methodology has highlighted some areas needed of improvement or are undocumented.

explictly state the guide's referenced OS eg; Ubuntu 18.04
provide external reference to a guide on SSH generation and management
provide instructions how to install dependencies
- docker-compose install script
- docker install script
- git installation
- nginx installation
recommend explictly stating usage of the cp command to copy configuration templates
include prioritised UFW ruling for SSH, to prevent server conflicts
exclude invalid instructions about starting then stopping compose deployments to be followed by changing ports in docker-compose.yml
recommend simple directions of the echo command to append the stream parameters to the main nginx config
correct instructions to overwrite the default template of /etc/nginx/sites-available/default with tornado.conf

This has been a long-needed improvement in documentation for the relayer process, however trying to follow the guide to test the methodology has highlighted some areas needed of improvement or are undocumented. * explictly state the guide's referenced OS eg; Ubuntu 18.04 * provide external reference to a guide on SSH generation and management * provide instructions how to install dependencies * [docker-compose install script](https://www.digitalocean.com/community/tutorials/how-to-install-docker-compose-on-ubuntu-18-04) * [docker install script](https://github.com/docker/docker-install) * git installation * nginx installation * recommend explictly stating usage of the cp command to copy configuration templates * include prioritised UFW ruling for SSH, to prevent server conflicts * exclude invalid instructions about starting then stopping compose deployments to be followed by changing ports in `docker-compose.yml` * recommend simple directions of the echo command to append the stream parameters to the main nginx config * correct instructions to overwrite the default template of `/etc/nginx/sites-available/default` with `tornado.conf`

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: tornadocash/tornado-relayer#1