⚙️
TMC v2 Core
DiscordWebsite
  • Guides
    • Get Started
    • Kuzzle
  • TMC Core Object
    • Client Functions
      • Vehicle Functions
      • Interaction Ped Functions
      • Interaction Object Functions
      • Interaction Prompts
      • Polyzones
    • Client Menus
    • Events
      • Client
      • Server
    • Server Functions
      • General Functions
      • Commands
      • Player Functions
    • Common Functions
    • 🚘Vehicle Names
  • Object Models
    • Job
  • 📄Other Resources
    • ✨Status Effects
    • 📤Dispatch
    • 🫂Parties
    • 💶Banking
    • 🔍Evidence
Powered by GitBook
On this page
  • KaaS (Kuzzle as a Service)
  • Self Hosting
  • Prerequisites
  • Guide
  • TMC Core Configuration
  • Server User
  1. Guides

Kuzzle

Kuzzle is a ready-made backend that allows TMC servers to offload large datasets into one easy to access place. Kuzzle also assists with distributing data to clients directly increasing performance.

PreviousGet StartedNextClient Functions

Last updated 9 days ago

KaaS (Kuzzle as a Service)

If you'd rather focus on your development and community rather than the infrastructure required for Kuzzle then TMC offers Kuzzle as a Service. You can purchase this on our services store. We'll handle the hosting, upkeep and maintenance whilst you can focus on building the best community you can.

Self Hosting

Prerequisites

  • Fully configured Kuzzle instance

  • Admin access to your Kuzzle Admin Console

  • An index to add the collections to

  • A copy of our default collections downloaded

Guide

Navigate to the index you want to create. Click "Create a Collection" then follow the steps below.

  1. Enter the name of the collection. This should match the name of the file you are importing. I.e. dispatch_calls.json becomes dispatch_calls.

  2. Browse to and select the json file for this collection.

  3. Click "Create".

Repeat these steps for each collection.

TMC Core Configuration

Server User

  • You must create a server profile & user that has access to the Kuzzle index and has permission to create users.

  • You must create a profile for each user that only has access to read/write to the relevant indexes.

    • This profile should be able to list, get, update and delete from each collection.

    • This profile should have special permissions to use mDelete on the notifications collection.

    • This profile should have special permissions to mGet on the racing_profiles, racing_users, racing_tracks, burner_boards & mdt_crimes collections.

  • Once this has been set up you can create an API key for your server user.

You can then proceed to fill in your core/config.server.lua

Config.Server.Kuzzle = {
    Host = '', -- The host of your kuzzle server.
    Port = 443, -- The port of your kuzzle server.
    Ssl = true, -- True/False depending on if you are using SSL.
    Index = '', -- The name of the index of your kuzzle server.
    SecretKey = '', -- The api key you generated above.
    PlayerProfileName = '' -- The profile name you created for each user. Ensure this only has the specified permissions.
}
step-by-step