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 diff --git a/README.md b/README.md index d0e6645..49bd481 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,41 @@ 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 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 + +systemctl status telebit-relay +journalctl -xefu telebit-relay +``` + Usage ==== diff --git a/examples/telebit-relay.yml b/examples/telebit-relay.yml index 239d017..74e83d6 100644 --- a/examples/telebit-relay.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