Skip to content

quickstart.mdx

Latest commit

 

History

History
65 lines (51 loc) · 2.93 KB

quickstart.mdx

File metadata and controls

65 lines (51 loc) · 2.93 KB
Raw
title FiveMesh quickstart for FiveM servers
sidebarTitle Quickstart
description Activate a plan, register your FiveM server and set up FiveMesh CDN, Cache, Voice, Logs or Portal from the dashboard.
icon rocket

This guide takes you from a new account to your first configured service.

Prerequisites

  • A FiveMesh account with a verified email address.
  • Trial or subscription access before activating services.
  • Your cfx.re join code for Cache, Voice, Logs or Portal.
  • Access to server.cfg for server-side integrations.

Get started

Open the [FiveMesh dashboard](https://app.fivemesh.io) and sign in. You land on **Overview**. 
You can use the dashboard without an organization or subscription.
Open **Billing** and choose a plan or confirm your existing subscription. Active and trialing subscriptions allow service setup. Logs requires Growth or Pro. Open **Servers**, register your cfx.re join code and review the detected details. 
CDN can operate without a registered server. Cache, Voice, Logs and Portal require one.
Use the selector at the top of the sidebar to choose **My account** or an organization, then select your registered server. 
An organization is optional. It shares access to its owner's resources without moving billing or ownership.
Open **CDN** to configure public asset delivery, **Cache** to proxy resource downloads, **Voice** to create managed PMA-Voice infrastructure, or **Logs** to connect server events. 
Follow the service setup guide below and wait for provisioning to finish.

Common first paths

Goal Where to go
Host inventory images, NUI assets or phone media Set up FiveMesh CDN
Speed up resource downloads with fileserver_add Set up FiveMesh Cache
Connect phone or tablet uploads LB-Scripts, Quasar Phone or sd-phone
Run managed PMA-Voice infrastructure Set up FiveMesh Voice
Collect and search server events Set up FiveMesh Logs
Let Discord members upload media Set up FiveMesh Portal
Connect official FiveMesh resources Generate a Server API Key
Create keys for custom integrations Developer API Keys
Invite operators Organizations

Not sure whether you need CDN or Cache? See CDN or Cache?.

Next steps