Hosting a server

Deployment

In terms of deployment and how you want to configure your server, we will leave that up to you. We do not provide dedicated support on how to deploy this application, as there are many different methods and server architectures.

In our case, we are using a VPS running Ubuntu with Node version 18.6, with a reverse proxy to port 443 to enable HTTPS. We are also using Cloudflare CDN for our assets, however, this is not a hard requirement.

Follow the steps that are outlined in Server & Database Setup in order to get setup with the server.

Pointing the client to your server

In order to point the client to your server, you will need to decompile the SWF binary, which you can do by downloading the JPEXS Free Flash Decompiler and open the SWF.

From here, you should navigate to the default-package directory, and look for the GLOBAL.as file. Here you will see a variable called serverURL. Change this to the URL of your server, and save the file (both the save button of the file itself, and also the save button in the top-left to do a hard save on the binary).

API Versioning

Our server currently uses API versioning to invalidate clients after an update. We define our version based on the latest client file name from our GitHub Releases, using a webhook. This implementation can be found in server/src/controllers/github.

If you want to avoid API versioning altogether just to get your server working, you can set USE_VERSION_MANAGEMENT to "disabled" in the .env file, or hardcode the version in server.ts:

/**
* An example hardcoded version in `server.ts` - must match what's on the client.
* Version on the client is defined in `GLOBAL.as` as the variable name apiVersionSuffix
* Keep the formatting the same e.g. v{versionNumber}-{release}
*/
export const getApiVersion = () => "v1.1.0-beta";