Skip to content

Install on a handset

This guide sets up one handset: it installs ATAK and the Crux plugin, connects the tunnel, and connects ATAK to your TAK Server. It takes about fifteen minutes, and you don't need a computer. Use a normal internet connection, such as home or office Wi-Fi.

Before you begin

Your administrator sends you three things for each handset:

Item What it looks like What it is
A download link A long web address Where the Crux plugin comes from
crux-setup.conf A text file This handset's identity and tunnel
A data package A .zip file This handset's connection to the TAK Server

The two files belong to one handset. If you're setting up more than one, keep each handset's files apart, because a file loaded on the wrong handset stops both from working.

1. Install ATAK

  1. Open the Google Play Store.
  2. Search for ATAK-CIV and install it.
  3. Open ATAK and work through the first-run prompts until you see a map.

Leave ATAK open. You come back to it in step 4.

2. Install the Crux plugin

The Crux plugin isn't in the Google Play Store. Install it only from the link that your administrator sent.

  1. Open Chrome on the handset.
  2. Tap the download link that you were sent. The download starts on its own and is about 36 MB.
  3. Open the downloaded file and tap Install.
  4. If Android warns you about installing from an unknown source, allow it.

If Android refuses to install the file, go to Settings > Apps > Chrome > Install unknown apps, turn it on, and open the file again.

3. Download your two files

Download crux-setup.conf and the data package to the handset, from wherever your administrator sent them. They go into your Downloads folder. Don't open them, and don't rename them.

4. Load the plugin in ATAK

Installing the plugin doesn't turn it on. ATAK has to load it.

  1. Go back to ATAK.
  2. Tap ☰ in the top right.
  3. Tap Settings.
  4. Tap Tool Preferences.
  5. Tap Package Management.
  6. Tap Crux in the list.
  7. Tap Load, then OK.

The list now shows Loaded, and Crux appears in the ☰ menu. If it doesn't, close ATAK completely and open it again.

5. Register the handset

  1. Press back until you see the map.
  2. Tap ☰, then Crux. A pane opens that says Registration Required.
  3. Tap Load Config (crux-setup.conf). A file browser opens.
  4. Tap ☰ in the file browser's top left, then tap Downloads.
  5. Tap crux-setup.conf.

The pane shows Setting up Crux… for up to a minute, then Registered. Ready to connect.

If the pane says that the code has already been used or has expired, stop and ask your administrator for a new crux-setup.conf. The file works only once.

6. Connect the tunnel

Caution

Turn off any other VPN app on the handset first. Android allows one VPN at a time, so another VPN app takes the connection and drops the tunnel.

  1. Tap Connect.
  2. When Android asks for permission to set up a VPN, tap OK.

After a few seconds, the pane shows Connected, with a byte count and the time since the last handshake. A small key icon appears in the status bar. Connecting takes a little longer than a normal VPN, because the handset agrees its encryption key with the server instead of storing one.

7. Connect to the TAK Server

The tunnel has to be connected first, because the TAK Server can be reached only through it.

Caution

Don't use Quick Connect. It ignores the certificates in your data package and replaces the connection that you imported.

  1. Tap ☰, then Settings.
  2. Tap Network Preferences.
  3. Tap Network Connection Preferences.
  4. Tap Manage Server Connections.
  5. Tap ⋮ in the top right, then Data Package.
  6. In the file browser, go to Downloads and tap your .zip file.

8. Check the connection

Stay on Manage Server Connections and look at the dot next to the server entry.

A green dot means that the handset is connected to the TAK Server, and you're finished. A red dot means that it isn't connected yet. ATAK retries on its own, so wait thirty seconds. If the dot stays red, check that the Crux pane still shows Connected, then see Troubleshooting.

Keep the handset working

A few actions undo the setup, so avoid the following:

  • Don't tap Deregister Device in the Crux pane. It discards the setup, and you need a new crux-setup.conf to get it back.
  • Don't load one handset's files on another handset.
  • Don't reinstall or update the plugin unless your administrator asks. After an update, ATAK unloads the plugin, and you need to repeat step 4.