From 45774d7e61a19e9b5e72967bc3732a3dac5cb8a8 Mon Sep 17 00:00:00 2001 From: Ricardo Arturo Cabral Mejia Date: Sun, 6 Nov 2022 19:30:29 -0500 Subject: [PATCH] docs(README): add steps to run over Tor --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index fa148940..4c214ca3 100644 --- a/README.md +++ b/README.md @@ -80,6 +80,32 @@ Stop the server with: npm run docker:compose:stop ``` +## Quick Start (over Tor) + +Install Docker following the [official guide](https://docs.docker.com/engine/install/). +You may have to uninstall Docker if you installed it using a different guide. + +Clone repository and enter directory: + ``` + git clone git@github.com:Cameri/nostr-ts-relay.git + cd nostr-ts-relay + ``` + +Start with: + ``` + npm run tor:docker:compose:start & + ``` + +Print the Tor hostname: + ``` + npm run tor:hostname + ``` + +Stop the server with: + ``` + npm run tor:docker:compose:stop + ``` + ## Quick Start (Standalone) Set the following environment variables: