sentry - Setup instructions

sentry initializes wallet data for ghost and tower and may optionally be run to update tower on available e-notes ("outputs").

If used exclusively for initialization, it is sufficient to run it once, fully offline, just to compute the key URI's for gate and tower.

Requirements

Sending updates to tower will only be necessary if the wallet state ever deviates, which should only happen when (A) a wallet is also used outside the context of NoShore, i.e. by spending from a third-party software or (B) when importing a previously used wallet for the first time.

To use sentry for sending those updates, it must be run on a machine that can reach tower, typically through the Internet.

To keep its keys protected, sentry does not and should not to be reachable itself on the Internet.

Therefore, a good place to run sentry is your local computer or a firewalled device on a protected network.

Preparation

As root:

  1. Make sure both git and openssh are installed on your system

  2. [skip unless on Alpine Linux] Also add util-linux-login to get a compatible su-command

     # Since we're at it, let's satisfy all dependencies at once:
     apk add bat coreutils-fmt curl git jq monero netcat-openbsd \
             openssh procps-ng util-linux-login util-linux-misc
    

  3. Create a dedicated user "sentry"

     # Depending on your Linux flavor, one of these commands may work:
     useradd -c 'noshore scanner' -m sentry
     # or
     adduser -Dg 'noshore scanner' sentry
    

Installation

As the newly created user (switch with su -Pl sentry):

  1. Get sentry by cloning NoShore:

     git clone --branch v0.1.1 \
         https://gitlab.com/fullmetalScience/noshore.git ~/xmr.zone/noshore
    

  2. Run and re-run setup until you have taken care of all suggested configuration:

     ~/xmr.zone/noshore/sentry/manage.sh setup
    

Setup creates a shorthand command sentry. If ~/.local/bin is in your $PATH, you may use that instead of the long form ~/xmr.zone/noshore/sentry/manage.sh.

You may want to install tower next.