Server

Windows
Linux
macOS

Hosting the server api is supported.
Hosting the web server is supported.

Download

Contact use for the initial download address.

tip

We distribute TaskForger Server through secure download links, similar to standard release platforms.

Windows

Follow the installation instructions for the Windows executable.
Use the shortcuts to start the application.

info

Use the Primary server shortcut for your primary servers.

Mongo

You must have accessing to a running mongodb. Either install manually use docker or you can use mongoatlas.

Server Environment variables

These environment variables configure the API server's behavior and connections.

Variable	Default	Required	Description
TF_SECRET_KEY	"PLACEHOLDER_SECRET_KEY"	Yes	Secret key used for JWT authentication (change in production)
TF_SERVER_PORT	8089	No	The port number used by the API server
TF_SERVER_HOST	"127.0.0.1"	No	The host address for the API server
TF_WORKERS	2	No	Number of worker processes for the server
TF_NETWORK_DRIVE	"D://network"	No	Local path for network drive
TF_NETWORK_PATH	"//PDC-SERV/network"	No	Network path for server files
TF_SERVER_DOMAIN	"X"	No	Domain for the server
TF_MONGO_CONNECTION	"mongodb://localhost:27017/"	No	MongoDB connection string
TF_ORGANIZATION	"default"	No	MongoDB organization database name
TF_EMAIL_CLIENT	""	No	Email client configuration
TF_EMAIL_FROMADDR	""	No	Email sender address
TF_EMAIL_USERNAME	""	No	Email username
TF_EMAIL_FROMPASSWORD	""	No	Email password

important

TF_MONGO_CONNECTION must be set to a valid MongoDB connection string. TF_SECRET_KEY should be changed from the default value in production environments.

Setting environment variables in Windows

Using Command Prompt:

set TF_SERVER_ADDRESS=https://taskforger-server.example.com
set TF_PORT=9000

Or through Windows GUI:

Search for "Environment Variables" in the Start menu
Click "Edit the system environment variables"
Click "Environment Variables" button
Under "User variables", click "New" to add each variable

Hosting the webserver

Follow the desktop-client setup but be sure to set and adjust

Variable	Default	Required	Description
TF_WEB_SERVER_ENABLED	False	No	Enables the web server functionality when set to True
TF_LOCAL_DRIVE	"C://Taskforger/"	No	The local drive path where TaskForger stores its data

Hosting

You can host on multiple machines if you wish and if you want HTTPS you can use a reverse proxy such as Caddy.

Setting up SSL with Caddy

Caddy makes SSL configuration simple with automatic HTTPS

# TF CLIENT with SSL
cinestron.dyndns.org:8088 {
    reverse_proxy 127.0.0.1:8088
}

# For TF SERVER with SSL
cinestron.dyndns.org:8089 {
    reverse_proxy 127.0.0.1:8089
}

# For LAN access (no SSL needed)
192.168.2.1:8099 {
    reverse_proxy 127.0.0.1:8099
}

For faster LAN access and to not go through the reverse proxy it is safe to use and run multiple instances.

Variable	Set	Description
TF_SERVER_PORT	8099	Port for th LAN api
TF_SERVER_HOST	"0.0.0.0"	List on all network interfaces

Download​

Windows​

Mongo​

Server Environment variables​

Setting environment variables in Windows​