Skip to main content
This guide will help you install FreeTAKServer, start the server, and connect your first ATAK client in under 10 minutes.

​
Prerequisites

Before you begin, ensure you have:
  • Python 3.11 or higher installed
  • Pip package manager
  • Command line access
  • Network connectivity
  • An ATAK, WinTAK, or iTAK client for testing
For detailed system requirements and platform-specific dependencies, see the installation guide.

​
Installation

1

Install FreeTAKServer via pip

Install the latest version of FreeTAKServer from PyPI:
pip3 install FreeTAKServer
This will install FreeTAKServer and all required dependencies including Flask, SQLAlchemy, lxml, and the DigitalPy framework.
Add [ui] to install the optional web UI: pip3 install FreeTAKServer[ui]
2

Verify installation

Check that FreeTAKServer is installed correctly:
python3 -m FreeTAKServer.controllers.services.FTS --help
You should see the help output with available command-line options.
3

Check your IP address

Find your IP address to configure the data package service:
# Internal network IP
ip addr show | grep "inet " | grep -v 127.0.0.1

# Or use hostname
hostname -I
Note your IP address for the next step (e.g., 192.168.1.100).
Use your machine’s actual IP address, not localhost or 127.0.0.1, so TAK clients can download data packages.

​
Starting the server

1

Start FTS with default configuration

Launch FreeTAKServer with your IP address:
python3 -m FreeTAKServer.controllers.services.FTS -DataPackageIP [YOUR_IP]
Replace [YOUR_IP] with your actual IP address from step 3.Example:
python3 -m FreeTAKServer.controllers.services.FTS -DataPackageIP 192.168.1.100
On first run, FTS will create configuration files in your home directory under .FreeTAKServer/.
2

Wait for services to start

FTS will start multiple services. Look for these startup messages:
Starting CoT Service on 0.0.0.0:8087
Starting TCP Data Package Service on 0.0.0.0:8080
Starting REST API Service on 0.0.0.0:19023
CoT Service Started
When you see these messages, the server is ready to accept connections.
3

Verify services are running

By default, FTS starts these services:
ServicePortProtocolPurpose
TCP CoT Service8087TCPMain client connections
HTTP Data Package Service8080HTTPData package downloads
REST API Service19023HTTPAPI endpoints
Leave the terminal window open. Closing it will stop the server.

​
Connecting your first client

Now that FTS is running, let’s connect an ATAK client.
1

Configure ATAK connection

On your ATAK device:
  1. Open ATAK
  2. Tap the menu icon (three lines) in the top-right
  3. Select Settings → Network Preferences → Network Connections
  4. Tap Add to create a new connection
2

Enter server details

Configure the connection with these settings:
SettingValue
DescriptionFreeTAKServer
AddressYour server IP (e.g., 192.168.1.100)
Port8087
ProtocolTCP
Leave other settings at their defaults.
3

Connect to the server

  1. Save the connection configuration
  2. Tap the connection to enable it
  3. Look for Connected status
In ATAK, connected clients appear on the map. You should see your own position marker once connected.
4

Test the connection

Verify the connection is working:In ATAK:
  • Your callsign should appear on the map
  • Drop a marker and it should persist on the server
  • Check the chat - you should be able to send messages
In the FTS terminal: You should see connection logs:
Client connected from 192.168.1.50:54321
Received COT event from [CALLSIGN]

​
Testing server functionality

Try these features to verify FTS is working correctly:
  1. In ATAK, open the hamburger menu
  2. Select Chat → All Chat Rooms
  3. Send a message
  4. If you have multiple clients connected, they should all receive the message
  1. Long-press on the map to drop a marker
  2. Add a name and remarks
  3. Send the marker
  4. The marker should be visible to all connected clients
  1. Take a photo with ATAK’s Quick Pic tool
  2. Send it to “All Chat Rooms” or a specific contact
  3. Other clients should receive a notification and be able to download the image
Data packages require proper IP configuration. If downloads fail, verify you used your correct IP address (not localhost) when starting FTS.
Test the REST API is accessible:
curl http://YOUR_IP:19023/ManagePresence/getAll
You should receive JSON data showing connected clients.

​
Using the public test server

If you want to test ATAK connectivity before setting up your own server, you can use the FreeTAKTeam public instance:
1

Download configuration

Download the server configuration from: https://drive.google.com/file/d/1IK1LfPN13EWikHaMyOuDDwIerNGz-Wli/view
2

Import in ATAK

  1. Transfer the .pref file to your device
  2. In ATAK, go to Settings → Import
  3. Select the configuration file
  4. Enable the connection
3

Connect to public server

The public server address is:
  • IP: 137.184.101.250
  • Port: 8087
  • Protocol: TCP
The public server is for testing only. Do not use it for sensitive or operational data.

​
Troubleshooting

Check network connectivity:
# From client device, ping the server
ping YOUR_SERVER_IP
Verify firewall rules:
  • Ensure port 8087 is open on your server
  • Check firewall isn’t blocking connections
On Linux, allow the port:
sudo ufw allow 8087/tcp
sudo ufw allow 8080/tcp
This usually means the -DataPackageIP is incorrect.Solution:
  1. Stop FTS (Ctrl+C)
  2. Restart with the correct IP address
  3. Make sure you’re using the IP address that clients can reach, not localhost
For internet-accessible servers: Use your public IP address, not your local network IP.
If you get ModuleNotFoundError when starting FTS:
# Ensure FreeTAKServer is installed
pip3 list | grep FreeTAKServer

# Reinstall if needed
pip3 install --force-reinstall FreeTAKServer
If ports 8087 or 8080 are already in use:Find what’s using the port:
# Linux/macOS
sudo lsof -i :8087

# Windows
netstat -ano | findstr :8087
Use different ports: You can specify custom ports when starting FTS (see installation guide for details).
If WinTAK can’t connect:
  1. Try disabling the TAKChat plugin in WinTAK
  2. Go to Plugins → TAKChat → Disable
  3. Restart WinTAK and try connecting again

​
Next steps

Now that you have FTS running, explore these topics:

Full installation guide

Learn about system services, SSL setup, and production deployment

Configuration

Customize ports, enable SSL, and configure advanced features

Authentication

Set up authentication and user accounts

REST API

Integrate FTS with your applications using the REST API
Join the FreeTAKServer Discord to get help from the community and stay updated on new features.

Build docs developers (and LLMs) love

Get started for freeTalk to us