tornadocash/tornado-relayer
2
0
Fork 0
Code Issues 3 Pull Requests Packages Projects Releases Wiki Activity

Update 'README.md' #1

Merged
Theo merged 1 commits from refs/pull/1/head into master 2023-02-19 05:23:49 +03:00
Conversation 1 Commits 1 Files Changed 3 +157 -22
Theo commented 2022-11-09 02:09:02 +03:00
Owner
Copy Link

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

Add comprehensive instructions on how to setup a Relayer with NGINX and Docker Compose.
Theo commented 2023-01-20 19:13:54 +03:00
Author
Owner
Copy Link

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
  • 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.
Reviewers
No reviewers
Labels
Clear labels   
BUG

Something is not working

  
ENHANCEMENT

New feature

  
QUESTION

More information is needed

  
RESEARCH

Open design goal

No Label
BUG
ENHANCEMENT
QUESTION
RESEARCH
Milestone
Clear milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
1 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: tornadocash/tornado-relayer#1
No description provided.
Delete Branch "refs/pull/1/head"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?