Skip to content

Getting Started

Jump to bottom
Greg Buehler edited this page Apr 3, 2022 · 3 revisions

Quickstart

  1. Go grab the latest release zip or tarball.
  2. Unarchive to your directory of choice.
  3. Review opentakrouter.json to see the default configuration.
  4. Run opentakrouter.
  5. Browse to http://localhost:8080 to see the admin pages.
  6. Connect your EUD to your host on port 8087.

Running as a service under Linux

1. Create a service user

We highly recommend running as a service user and this documentation includes that process. This creates a system user with no home directory that has no shell.

$ sudo useradd --system --no-create-home --shell=/sbin/nologin otr

2. Download and deploy the latest release

Get the url for the latest release. If you are deploying on an ARM chipset (like a Raspberry Pi) you will want to use the linux-arm64 archive instead.

$ curl -L -o /tmp/opentakrouter.tar.gz https://github.com/darkplusplus/opentakrouter/releases/download/v1.0.10/opentakrouter-v1.0.10-linux-x64.tar.gz
$ mkdir /opt/otr
$ tar -xzvf /tmp/opentakrouter.tar.gz -C /opt/otr
$ chown -R otr:otr /opt/otr

3. Configure

You may now edit your configuration. You may want to reference the configuration documentation.

$ nano /opt/otr/opentakrouter.json

4. Enable service and start

We will now create a service definition and configure it.

$ cat > (/etc/systemd/system/opentakrouter.service) <<EOF
[Unit]
Description=OpenTakRouter service
After=network.target

[Service]
Type=simple
Restart=always
RestartSec=5
User=otr
ExecStart=/opt/otr/opentakrouter

[Install]
WantedBy=multi-user.target
EOF

$ sudo systemctl daemon-reload
$ sudo systemctl enable opentakrouter
$ sudo systemctl start opentakrouter

4. Verify things are working

You may want to check the service status.

$ sudo systemctl start opentakrouter

Or you may want to check the logs.

$ sudo journalctl -u opentakrouter

Running as a service under Windows

1. Download and deploy the latest release

Download the latest release. Unzip it where you'd like to run it. For this configuration we're going to use C:\opentakrouter.

2. Configure

You may now edit your configuration at C:\opentakrouter\opentakrouter.json. You may want to reference the configuration documentation.

3. Create and start the service

Open a command prompt as Administrator. Issue the command to create a service using a binary. You may want to reference some of the settings for service creation at https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/sc-create.

sc create opentakrouter bin="C:\opentakrouter\opentakrouter.exe" start="delayed-auto"
sc start opentakrouter

Verify that the service is running. You can also try navigating to http://localhost:8080 if you are using the default configuration.

sc query opentakrouter
Clone this wiki locally