====== XRouter running as a systemd service ======


As XRouter is distributed as a loose binary, a little work is needed to get it set up as a service.


  * Set up a dedicated user to run as ("xr" in this example)
  * Copy the XRouter binary for your platform (probably xrpi64 or xrlin64) to the home directory
  * Run as the user for initial setup.
  * Create a service specification, using the below as a guide.
  * Profit.

==== Sample systemd service =====

<code>
[Unit]
StartLimitIntervalSec=5
Description=XRpi service
After=network.target
StartLimitIntervalSec=0
[Service]
Type=forking
Restart=always
RestartSec=5
User=xr
WorkingDirectory=/home/xr
ExecStart=/home/xr/xrpi64 -d

[Install]
WantedBy=multi-user.target

</code>


===== Network Access to XRouter from other subnets =====

XRouter uses a file called ACCESS.SYS in it's working directory to determine what rules are in place for accessing the instance - if it is present.

If you need to access the instance from another network, you will need to create the file and enter the network addresses and CIDR masks that you wish to permit.

e.g.

<code>
192.200.0.0/24 1
</code>


Syntax is as follows:

<subnet>[/bits] <access_flags>

The <access_flags> parameter is the sum of these flag values.

    * 1 - Valid callsigns only
    * 2 - Password required
    * 4 - Guest access allowed

More information on ACCESS.SYS config can be found on the [[https://ohiopacket.org/xrpi/docs/access.sys.htm|Ohio Packet documentation pages]].

Working example:

<code>
# cat /etc/systemd/system/xrouter.service
[Unit]
StartLimitIntervalSec=5
Description=XRpi service
After=network.target
StartLimitIntervalSec=0

[Service]
Type=forking
Restart=always
RestartSec=5
User=xr
WorkingDirectory=/home/xr
ExecStart=/home/xr/xrlin64 -d

[Install]
WantedBy=multi-user.target
</code>



====== G7TAJ way of retaining console access ======


I do it like this

Create a user xrpi
Make sure the xrpi files are read/writeable by this user.
I change the owner to them and group to pi.

<code>chown -R xrpi:pi /home/pi/xpri</code>


create a file :
<code>/etc/systemd/system/xrpi.service</code>

<code>
[Unit]
StartLimitIntervalSec=5
Description=XRpi service
After=network.target
StartLimitIntervalSec=0

[Service]
Type=forking
Restart=always
RestartSec=5
User=pi
ExecStart=/usr/bin/tmux new-session -s XRpi -d '/usr/bin/sudo -su xrpi /home/pi/xrpi/start-xrpi.sh'

[Install]
WantedBy=multi-user.target
</code>

create the start-xrpi.sh script called above
<code>
#!/bin/bash
cd /home/pi/xrpi
./xrpi
</code>

enable the service
<code>systemctl enable xrpi.service</code>


start it
<code>systemctl start xrpi.service</code>


Then, to get to xrpi, just do a <code>tmux a</code>

To get out, <code>ctrl-b d</code>