FakkelBrigade server reservations

A web-interface to reserve TF2 gameservers

Requirements

Ruby, preferbly 3.1+, but other versions might work. You should use ruby-build to install Ruby.
A Steam API key for user sign in
Postgres database
Redis

Server Requirements

A Source game dedicated server installation, only tested with TF2 on linux for now.
Gameserver started with -port PORTNUMBER -autoupdate in the startup line
libmaxminddb, for GeoIP lookups. Or you can configure another one in the geocoder initializer

Running locally

Make sure you've installed the requirements.
Review the yaml files in the config directory.
Get a steam api key https://steamcommunity.com/dev/apikey
Create a new file at config/initializers/steam.rb with the folowing:

STEAM_WEB_API_KEY = '<your_api_key_here>'

Go to https://dev.maxmind.com/geoip/geoip2/geolite2/ and download the GeoLite2 City DB file. unzip and place in /doc/ folder.
Install required libraries for nokogiri (doc can be found here)
Install the required gems using bundler: gem install bundler && bundle Hint you may need to install some header files for for
Edit the seed data in db/seeds.rb i.e the servers list
Setup and migrate the databases: rake db:create db:migrate db:seed RAILS_ENV=development
Start the webserver: rails s
Add exec reservation.cfg to the server.cfg of the gameserver

Servers

There's currently no web interface for adding/editing servers (pull requests welcome). So you'll have to enter them manually in the database or using the rails console.

Here's how you add a local server:

LocalServer.create(:name => "Name",
                   :ip   => "server_ip_or_hostname",
                   :port => "server_port",
                   :path => "/absolute/path/on/file/system")

The local servers should run with the same user as the web application, if you don't like this, use the ssh interface for managing 'remote' servers.

And this is how you add a remote server:

SshServer.create(:name => "Name",
                 :ip   => "server_ip_or_hostname",
                 :port => "server_port",
                 :path => "/absolute/path/on/file/system")

The user running the web application needs to be able to ssh to the remote server, you should use passwordless key-based authorization for this, add an entry in ~/.ssh/config for each remote machine.

Host server_ip_or_hostname
  Hostname server_ip_or_hostname
  Port remote_ssh_port_if_not_22
  User remote_user
  IdentityFile ~/.ssh/id_rsa_for_remote_server

API

There's a simple JSON API to create and stop reservations. It typically returns a prefilled JSON response, which you can edit and send to one of the URLs listed in the "actions".

Interactive API Documentation

NEW: Complete interactive Swagger API documentation is now available at:

EU: https://serveme.tf/api-docs
NA: https://na.serveme.tf/api-docs
AU: https://au.serveme.tf/api-docs
SEA: https://sea.serveme.tf/api-docs

The Swagger documentation provides complete schemas, examples, and a testing interface for all API endpoints.

Important: API keys are region-specific. Use the API key from the same region as the endpoint you're calling:

EU: https://serveme.tf (API keys from EU account)
NA: https://na.serveme.tf (API keys from NA account)
AU: https://au.serveme.tf (API keys from AU account)
SEA: https://sea.serveme.tf (API keys from SEA account)

Authentication

All API endpoints require authentication using one of these methods:

Query Parameter: Add ?api_key=your_api_key to any request
Authorization Header: Use either format:
- Authorization: Token token=your_api_key
- Authorization: Bearer your_api_key

Users can find their API key in their account settings page after signing in with Steam.

Step 1

curl -X GET -H "Content-Type: application/json" 'https://serveme.tf/api/reservations/new?api_key=your_api_key'

This will return a prefilled JSON response, which you can POST to the action "find_servers"

{
  "reservation": {
    "starts_at": "2014-04-13T18:00:20.415+02:00",
    "ends_at": "2014-04-13T20:00:20.415+02:00"
  },
  "actions": {
    "find_servers": "https://serveme.tf/api/reservations/find_servers"
  }
}

Step 2

POST a reservation with starts_at and ends_at filled in to find_servers.

curl -X POST -H "Content-Type: application/json" -d '{"reservation":{"starts_at":"2014-04-13T18:00:20.415+02:00","ends_at":"2014-04-13T20:00:20.415+02:00"}}' 'https://serveme.tf/api/reservations/find_servers?api_key=your_api_key'

This will return a prefilled JSON response with available servers, whitelists and server configs included:

{
  "reservation": {
    "status": "Unknown",
    "starts_at": "2014-04-13T18:00:20.415+02:00",
    "ends_at": "2014-04-13T20:00:20.415+02:00",
    "server_id": null,
    "password": null,
    "rcon": null,
    "first_map": null,
    "tv_password": "tv",
    "tv_relaypassword": "tv",
    "tv_port": null,
    "server_config_id": null,
    "whitelist_id": null,
    "custom_whitelist_id": null,
    "auto_end": true,
    "enable_plugins": true,
    "enable_demos_tf": false,
    "sdr_ip": null,
    "sdr_port": null,
    "sdr_tv_port": null,
    "sdr_final": false,
    "disable_democheck": false
  },
  "servers": [
    {
      "id": 64,
      "name": "FritzBrigade #10",
      "location": {
        "id": 8,
        "name": "Germany",
        "flag": "de"
      }
    }
  ],
  "server_configs": [
    {
      "id": 2,
      "file": "etf2l_6v6"
    },
    {
      "id": 3,
      "file": "etf2l_9v9"
    }
  ],
  "whitelists": [
    {
      "id": 2,
      "file": "etf2l_whitelist_6v6.txt"
    },
    {
      "id": 3,
      "file": "etf2l_whitelist_9v9.txt"
    }
  ],
  "actions": {
    "create": "https://serveme.tf/api/reservations"
  }
}

Step 3

POST a complete reservation to the "create" action

curl -X POST -H "Content-Type: application/json" -d '{"reservation":{"starts_at":"2014-04-13T18:00:20.415+02:00","ends_at":"2014-04-13T20:00:20.415+02:00","rcon":"foo","password":"bar","server_id":1337}}' 'https://serveme.tf/api/reservations?api_key=your_api_key'

If there's any errors, you'll get a HTTP 422 and a new prefilled reservation JSON with errors:

{
  "reservation": {
    "status": "Unknown",
    "starts_at": "2014-04-13T18:00:20.415+02:00",
    "ends_at": "2014-04-13T20:00:20.415+02:00",
    "server_id": null,
    "password": "bar",
    "rcon": "foo",
    "first_map": null,
    "tv_password": "tv",
    "tv_relaypassword": "tv",
    "tv_port": null,
    "server_config_id": null,
    "whitelist_id": null,
    "custom_whitelist_id": null,
    "auto_end": true,
    "enable_plugins": true,
    "enable_demos_tf": false,
    "sdr_ip": null,
    "sdr_port": null,
    "sdr_tv_port": null,
    "sdr_final": false,
    "disable_democheck": false,
    "errors": {
      "server": {
        "error": "can't be blank"
      },
      "starts_at": {
        "error": "can't be more than 15 minutes in the past"
      }
    }
  },
  "actions": {
    "create": "https://serveme.tf/api/reservations"
  },
  "servers": [
    {
      "id": 64,
      "name": "FritzBrigade #10",
      "location": {
        "id": 8,
        "name": "Germany",
        "flag": "de"
      }
    }
  ],
  "server_configs": [
    {
      "id": 19,
      "file": "wptf2l"
    }
  ],
  "whitelists": [
    {
      "id": 9,
      "file": "wp9v9_whitelist.txt"
    }
  ]
}

If everything went alright, you'll get a HTTP 200 and shown your reservation details:

{
  "reservation": {
    "id": 12345,
    "server_id": 64,
    "starts_at": "2014-04-13T19:00:20.415+02:00",
    "ends_at": "2014-04-13T20:00:20.415+02:00",
    "password": "bar",
    "rcon": "foo",
    "first_map": null,
    "tv_password": "tv",
    "tv_relaypassword": "tv",
    "tv_port": 27020,
    "server_config_id": null,
    "whitelist_id": null,
    "custom_whitelist_id": null,
    "auto_end": true,
    "enable_plugins": false,
    "enable_demos_tf": false,
    "sdr_ip": null,
    "sdr_port": null,
    "sdr_tv_port": null,
    "sdr_final": false,
    "disable_democheck": false,
    "last_number_of_players": 0,
    "inactive_minute_counter": 0,
    "logsecret": "298424416816498481223654962917404607282",
    "start_instantly": false,
    "end_instantly": false,
    "provisioned": true,
    "ended": false,
    "steam_uid": "76561198012345678",
    "status": "Started",
    "server": {
      "id": 64,
      "name": "Server name",
      "flag": "de",
      "ip": "127.0.0.1",
      "port": "27015",
      "ip_and_port": "127.0.0.1:27015",
      "sdr": false,
      "latitude": 52.5,
      "longitude": 13.4
    }
  },
  "actions": {
    "patch": "https://serveme.tf/api/reservations/12345",
    "delete": "https://serveme.tf/api/reservations/12345"
  }
}

Step 4

PATCH an updated reservation to the "update" action

curl -X PATCH -H "Content-Type: application/json" -d '{"reservation":{"ends_at":"2014-04-13T21:30:20.415+02:00","password":"newpassword","first_map":"cp_badlands"}}' 'https://serveme.tf/api/reservations/12345?api_key=your_api_key'

If there's any errors, you'll get a HTTP 422 and a prefilled reservation JSON with errors:

{
  "reservation": {
    "status": "Started",
    "starts_at": "2014-04-13T18:00:20.415+02:00",
    "ends_at": "2014-04-13T20:00:20.415+02:00",
    "server_id": 64,
    "password": "",
    "rcon": "foo",
    "first_map": null,
    "tv_password": "tv",
    "tv_relaypassword": "tv",
    "tv_port": 27020,
    "server_config_id": null,
    "whitelist_id": null,
    "custom_whitelist_id": null,
    "auto_end": true,
    "enable_plugins": false,
    "enable_demos_tf": false,
    "sdr_ip": null,
    "sdr_port": null,
    "sdr_tv_port": null,
    "sdr_final": false,
    "disable_democheck": false,
    "errors": {
      "password": {
        "error": "can't be blank"
      },
      "ends_at": {
        "error": "reservation can't be more than 2h long"
      }
    }
  },
  "actions": {
    "patch": "https://serveme.tf/api/reservations/12345"
  },
  "servers": [
    {
      "id": 64,
      "name": "FritzBrigade #10",
      "location": {
        "id": 8,
        "name": "Germany",
        "flag": "de"
      }
    }
  ],
  "server_configs": [
    {
      "id": 19,
      "file": "wptf2l"
    }
  ],
  "whitelists": [
    {
      "id": 9,
      "file": "wp9v9_whitelist.txt"
    }
  ]
}

If everything went alright, you'll get a HTTP 200 and shown your updated reservation details:

{
  "reservation": {
    "id": 12345,
    "server_id": 64,
    "starts_at": "2014-04-13T19:00:20.415+02:00",
    "ends_at": "2014-04-13T19:30:20.415+02:00",
    "password": "newpassword",
    "rcon": "foo",
    "first_map": "cp_badlands",
    "tv_password": "tv",
    "tv_relaypassword": "tv",
    "tv_port": 27020,
    "server_config_id": null,
    "whitelist_id": null,
    "custom_whitelist_id": null,
    "auto_end": true,
    "enable_plugins": false,
    "enable_demos_tf": false,
    "sdr_ip": null,
    "sdr_port": null,
    "sdr_tv_port": null,
    "sdr_final": false,
    "disable_democheck": false,
    "last_number_of_players": 0,
    "inactive_minute_counter": 0,
    "logsecret": "298424416816498481223654962917404607282",
    "start_instantly": false,
    "end_instantly": false,
    "provisioned": true,
    "ended": false,
    "steam_uid": "76561198012345678",
    "status": "Started",
    "server": {
      "id": 64,
      "name": "Server name",
      "flag": "de",
      "ip": "127.0.0.1",
      "port": "27015",
      "ip_and_port": "127.0.0.1:27015",
      "sdr": false,
      "latitude": 52.5,
      "longitude": 13.4
    }
  },
  "actions": {
    "patch": "https://serveme.tf/api/reservations/12345",
    "delete": "https://serveme.tf/api/reservations/12345"
  }
}

Step 5

After the match is over, you can end your reservation

First, you can check your reservation details:

curl -X GET -H "Content-Type: application/json" 'https://serveme.tf/api/reservations/12345?api_key=your_api_key'

This JSON response will tell you if the reservation hasn't ended by itself already with the "ended" boolean. If you want to end it yourself, you need to send a HTTP DELETE to the "delete" action URL:

curl -X DELETE -H "Content-Type: application/json" 'https://serveme.tf/api/reservations/12345?api_key=your_api_key'

The "delete" action will respond with a 204 if the reservation was deleted before it was started, else it will respond with a 200 and the reservation's information.

Additional API Endpoints

List Available Maps

curl -X GET 'https://serveme.tf/api/maps'

Returns a list of all available maps on the servers. This endpoint does not require authentication.

List Available Servers

curl -X GET 'https://serveme.tf/api/servers?api_key=your_api_key'

Returns a list of all active servers with their details and locations.

List Your Reservations

curl -X GET 'https://serveme.tf/api/reservations?api_key=your_api_key'

Returns a list of your reservations. Optional parameters:

limit - Number of results to return
offset - Offset for pagination
steam_uid - Filter by Steam UID (for admin/trusted API users)

Extend a Reservation

curl -X POST 'https://serveme.tf/api/reservations/12345/extend?api_key=your_api_key'

Extends the duration of an active reservation.

Get User Information

curl -X GET 'https://serveme.tf/api/users/76561198012345678?api_key=your_api_key'

Returns information about a user by their Steam UID.

Admin Endpoints

The following endpoints require admin permissions:

Manage Donators

# Get donator form template
curl -X GET 'https://serveme.tf/api/donators/new?api_key=your_admin_api_key'

# Get donator details  
curl -X GET 'https://serveme.tf/api/donators/76561198012345678?api_key=your_admin_api_key'

# Create/update donator status
curl -X POST -H "Content-Type: application/json" -d '{"donator":{"steam_uid":"76561198012345678","expires_at":"2024-12-31T23:59:59Z"}}' 'https://serveme.tf/api/donators?api_key=your_admin_api_key'

# Remove donator status
curl -X DELETE 'https://serveme.tf/api/donators/76561198012345678?api_key=your_admin_api_key'

League Requests (League Admin)

# Search league requests
curl -X GET 'https://serveme.tf/api/league_requests?api_key=your_league_admin_api_key&league_request[ip]=1.2.3.4'

For complete API documentation including all endpoints, request/response schemas, and interactive testing, visit the Swagger documentation for your region.

Name		Name	Last commit message	Last commit date
Latest commit History 5,197 Commits
.claude-on-rails		.claude-on-rails
.github/workflows		.github/workflows
app		app
bin		bin
config		config
db		db
doc		doc
features		features
lib		lib
log		log
public		public
script		script
sorbet		sorbet
spec		spec
swagger/v1		swagger/v1
tmp/tf/cfg		tmp/tf/cfg
vendor		vendor
.codeclimate.yml		.codeclimate.yml
.coverage		.coverage
.gitignore		.gitignore
.rspec		.rspec
.rubocop.yml		.rubocop.yml
.ruby-version		.ruby-version
Capfile		Capfile
Dockerfile		Dockerfile
Gemfile		Gemfile
Gemfile.lock		Gemfile.lock
LICENSE.MD		LICENSE.MD
README.md		README.md
Rakefile		Rakefile
claude-swarm.yml		claude-swarm.yml
config.ru		config.ru
docker-compose.yml		docker-compose.yml

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Repository files navigation

FakkelBrigade server reservations

Requirements

Server Requirements

Running locally

Servers

API

Interactive API Documentation

Authentication

Step 1

Step 2

Step 3

Step 4

Step 5

Additional API Endpoints

List Available Maps

List Available Servers

List Your Reservations

Extend a Reservation

Get User Information

Admin Endpoints

Manage Donators

League Requests (League Admin)

About

Uh oh!

Releases

Packages

Uh oh!

Contributors 11

Uh oh!

Languages

License

Arie/serveme

Folders and files

Latest commit

History

Repository files navigation

FakkelBrigade server reservations

Requirements

Server Requirements

Running locally

Servers

API

Interactive API Documentation

Authentication

Step 1

Step 2

Step 3

Step 4

Step 5

Additional API Endpoints

List Available Maps

List Available Servers

List Your Reservations

Extend a Reservation

Get User Information

Admin Endpoints

Manage Donators

League Requests (League Admin)

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors 11

Uh oh!

Languages

Packages