From bb08f7637d8516227ac510b6b5d4ecbdb1584e50 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ricardo=20Arturo=20Cabral=20Mej=C3=ADa?= Date: Tue, 20 Dec 2022 23:05:12 -0500 Subject: [PATCH] chore: add start/stop scripts --- README.md | 33 ++++++++------------------------- package.json | 14 ++++++-------- scripts/clean | 8 ++++++++ scripts/print_tor_hostname | 4 ++++ scripts/start | 7 +++++++ scripts/start_with_tor | 9 +++++++++ scripts/stop | 9 +++++++++ 7 files changed, 51 insertions(+), 33 deletions(-) create mode 100755 scripts/clean create mode 100755 scripts/print_tor_hostname create mode 100755 scripts/start create mode 100755 scripts/start_with_tor create mode 100755 scripts/stop diff --git a/README.md b/README.md index fd66600..3b79df8 100644 --- a/README.md +++ b/README.md @@ -87,42 +87,25 @@ Clone repository and enter directory: cd nostr-ts-relay ``` -Start with: +Start: ``` - npm run docker:compose:start -- --detach + ./scripts/start + ``` + or + ``` + ./scripts/start_with_tor ``` Stop the server with: ``` - npm run docker:compose:stop - ``` - -## Quick Start (over Tor) -`Docker` `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 + ./scripts/stop ``` Print the Tor hostname: ``` - npm run tor:hostname + ./scripts/print_tor_hostname ``` -Stop the server with: - ``` - npm run tor:docker:compose:stop - ``` ## Quick Start (Standalone) diff --git a/package.json b/package.json index d215f63..d9e1dba 100644 --- a/package.json +++ b/package.json @@ -37,14 +37,12 @@ "pretest:integration": "mkdir -p .test-reports/integration", "test:integration": "cucumber-js", "cover:integration": "nyc --report-dir .coverage/integration npm run test:integration -- -p cover", - "predocker:compose:start": "[ -d \"$PWD/.nostr\" ] || mkdir -p $PWD/.nostr", - "docker:compose:start": "docker compose up --build --remove-orphans", - "docker:compose:stop": "docker compose down", - "docker:compose:clean": "docker compose rm", - "pretor:docker:compose:start": "mkdir -p $PWD/.nostr/tor/data", - "tor:docker:compose:start": "docker compose -f docker-compose.yml -f docker-compose.tor.yml up --build --remove-orphans", - "tor:hostname": "cat $PWD/.nostr/tor/data/nostr-ts-relay/hostname", - "tor:docker:compose:stop": "docker compose -f docker-compose.yml -f docker-compose.tor.yml down", + "docker:compose:start": "./scripts/start", + "docker:compose:stop": "./scripts/stop", + "docker:compose:clean": "./scripts/clean", + "tor:docker:compose:start": "./scripts/start_with_tor", + "tor:hostname": "./scripts/print_tor_hostname", + "tor:docker:compose:stop": "./scripts/stop", "docker:integration:run": "docker compose -f ./test/integration/docker-compose.yml run --rm tests", "docker:test:integration": "npm run docker:integration:run -- npm run test:integration", "docker:cover:integration": "npm run docker:integration:run -- npm run cover:integration", diff --git a/scripts/clean b/scripts/clean new file mode 100755 index 0000000..f70c71a --- /dev/null +++ b/scripts/clean @@ -0,0 +1,8 @@ +#!/bin/bash +PROJECT_ROOT="$(dirname $(readlink -f "${BASH_SOURCE[0]}"))/.." + +$PROJECT_ROOT/scripts/stop_docker + +docker system prune + +docker volume prune diff --git a/scripts/print_tor_hostname b/scripts/print_tor_hostname new file mode 100755 index 0000000..b275c35 --- /dev/null +++ b/scripts/print_tor_hostname @@ -0,0 +1,4 @@ +#!/bin/bash + +PROJECT_ROOT="$(dirname $(readlink -f "${BASH_SOURCE[0]}"))/.." +cat $PROJECT_ROOT/.nostr/tor/data/nostr-ts-relay/hostname diff --git a/scripts/start b/scripts/start new file mode 100755 index 0000000..f9c0165 --- /dev/null +++ b/scripts/start @@ -0,0 +1,7 @@ +#!/bin/bash +PROJECT_ROOT="$(dirname $(readlink -f "${BASH_SOURCE[0]}"))/.." +DOCKER_COMPOSE_FILE="${PROJECT_ROOT}/docker-compose.yml" + +docker compose \ + -f $DOCKER_COMPOSE_FILE \ + up --build --remove-orphans $@ diff --git a/scripts/start_with_tor b/scripts/start_with_tor new file mode 100755 index 0000000..32b549e --- /dev/null +++ b/scripts/start_with_tor @@ -0,0 +1,9 @@ +#!/bin/bash +PROJECT_ROOT="$(dirname $(readlink -f "${BASH_SOURCE[0]}"))/.." +DOCKER_COMPOSE_FILE="${PROJECT_ROOT}/docker-compose.yml" +DOCKER_COMPOSE_TOR_FILE="${PROJECT_ROOT}/docker-compose.tor.yml" + +docker compose \ + -f $DOCKER_COMPOSE_FILE \ + -f $DOCKER_COMPOSE_TOR_FILE \ + up --build --remove-orphans $@ diff --git a/scripts/stop b/scripts/stop new file mode 100755 index 0000000..38eeb65 --- /dev/null +++ b/scripts/stop @@ -0,0 +1,9 @@ +#!/bin/bash +PROJECT_ROOT="$(dirname $(readlink -f "${BASH_SOURCE[0]}"))/.." +DOCKER_COMPOSE_FILE="${PROJECT_ROOT}/docker-compose.yml" +DOCKER_COMPOSE_TOR_FILE="${PROJECT_ROOT}/docker-compose.tor.yml" + +docker compose \ + -f $DOCKER_COMPOSE_FILE \ + -f $DOCKER_COMPOSE_TOR_FILE \ + down $@