From 24b42e1ed9cc564d6ceffe40f488d21ddcd1e883 Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Thu, 14 Jun 2018 21:21:48 +0000 Subject: [PATCH 1/5] manual install instructions for linux --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index d0e6645..71eceef 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,37 @@ Windows & Node.js There is [a bug](https://github.com/nodejs/node/issues/20241) in node v9.x that causes telebit-relay to crash. +Manually Install +----------- + +```bash +git clone https://git.coolaj86.com/coolaj86/telebit-relay.js.git telebit-relay + +# we're very picky to due to bugs in various versions of v8, v9, and v10 +export NODEJS_VER="v10.2.1" + +# We can keep everything self-contained +export NPM_CONFIG_PREFIX=/opt/telebit-relay +export NODE_PATH=/opt/telebit-relay/lib/node_modules + +curl -fsSL https://bit.ly/node-installer | bash -s -- --no-dev-deps + +pushd /opt/telebit-relay + bin/node bin/npm install + rsync -a examples/telebit-relay.yml etc/telebit-relay.yml + rsync -a dist/etc/systemd/system/telebit-relay.service /etc/systemd/system/telebit-relay.service +popd + +# IMPORTANT: Season to taste +edit /opt/telebit-relay/etc/telebit-relay.yml + +systemctl daemon-reload +systemctl restart telebit-relay + +systemctl status telebit-relay +journalctl -xefu telebit-relay +``` + Usage ==== From 6cfad96323e94b31c74c99f2c930308ce9199932 Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Thu, 14 Jun 2018 21:23:08 +0000 Subject: [PATCH 2/5] adduser telebit --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 71eceef..d3e8396 100644 --- a/README.md +++ b/README.md @@ -87,6 +87,8 @@ popd # IMPORTANT: Season to taste edit /opt/telebit-relay/etc/telebit-relay.yml +adduser --home /opt/telebit-relay --gecos '' --disabled-password telebit >/dev/null 2>&1 + systemctl daemon-reload systemctl restart telebit-relay From 02c3836883508ad315c0b6d068ec953c7f850e25 Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Thu, 14 Jun 2018 22:22:58 +0000 Subject: [PATCH 3/5] change user permissions --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d3e8396..49bd481 100644 --- a/README.md +++ b/README.md @@ -84,10 +84,12 @@ pushd /opt/telebit-relay rsync -a dist/etc/systemd/system/telebit-relay.service /etc/systemd/system/telebit-relay.service popd -# IMPORTANT: Season to taste +# IMPORTANT: Season the config file to taste +# IMPORTANT: change your email address and domain edit /opt/telebit-relay/etc/telebit-relay.yml adduser --home /opt/telebit-relay --gecos '' --disabled-password telebit >/dev/null 2>&1 +sudo chown -R telebit:telebit /opt/telebit-relay/ systemctl daemon-reload systemctl restart telebit-relay From f2cd8158f7d27e7c6ddbefc44548387e80d47198 Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Fri, 15 Jun 2018 05:16:23 +0000 Subject: [PATCH 4/5] ignore node files --- .gitignore | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.gitignore b/.gitignore index 7184f26..271d15d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,10 @@ node_modules.* +include +bin/node +bin/npm +bin/npx +share +etc # Logs logs From f94e01917ef454793b18b86b03f2caab86c99518 Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Fri, 15 Jun 2018 06:09:46 +0000 Subject: [PATCH 5/5] update example config --- examples/{telebitd.yml => telebit-relay.yml} | 2 ++ 1 file changed, 2 insertions(+) rename examples/{telebitd.yml => telebit-relay.yml} (95%) diff --git a/examples/telebitd.yml b/examples/telebit-relay.yml similarity index 95% rename from examples/telebitd.yml rename to examples/telebit-relay.yml index 239d017..74e83d6 100644 --- a/examples/telebitd.yml +++ b/examples/telebit-relay.yml @@ -2,6 +2,8 @@ email: 'jon@example.com' # must be valid (for certificate recovery and sec agree_tos: true # agree to the Telebit, Greenlock, and Let's Encrypt TOSes community_member: true # receive infrequent relevant updates telemetry: true # contribute to project telemetric data +webmin_domain: example.com +shared_domain: xm.pl servernames: # hostnames that direct to the Telebit Relay admin console - telebit.example.com - telebit.example.net