SnailyCAD

https://docs.snailycad.org
Admin
SnailyCAD is an open source Computer Aided Dispatch (CAD) for FiveM, this is a web based integration...
Tokens:30,048
Snippets:520
Trust Score:6.2
Update:4 months ago
Show doc for...
Tokens:
Raw
### Start NGINX on Windows

Source: https://docs.snailycad.org/docs/installations/reverse-proxies/nginx

Navigates to the NGINX installation directory and starts the NGINX server. This command must be run from a command prompt.

```bash
cd C:\nginx
nginx
```

--------------------------------

### Example Database Configuration

Source: https://docs.snailycad.org/docs/guides/recovery-tools

An example of how your database connection parameters should be configured.

```text
Database: snaily-cad  
Username: postgres  
Password: yourpassword  
Host: localhost  
Port: 5432  
```

--------------------------------

### Nginx Systemd Service File Example

Source: https://docs.snailycad.org/docs/installations/reverse-proxies/nginx

An example of a systemd service file for Nginx, defining how the service should be managed by systemd, including start, reload, and stop actions.

```systemd
# Stop dance for nginx  
# =======================  
#  
# ExecStop sends SIGSTOP (graceful stop) to the nginx process.  
# If, after 5s (--retry QUIT/5) nginx is still running, systemd takes control  
# and sends SIGTERM (fast shutdown) to the main process.  
# After another 5s (TimeoutStopSec=5), and if nginx is alive, systemd sends  
# SIGKILL to all the remaining processes in the process group (KillMode=mixed).  
#  
# nginx signals reference doc:  
# http://nginx.org/en/docs/control.html  
#  
[Unit]  
Description=A high performance web server and a reverse proxy server  
After=network.target  

[Service]  
Type=forking  
PIDFile=/run/nginx.pid  
ExecStartPre=/usr/sbin/nginx -t -q -g 'daemon on; master_process on;'  
ExecStart=/usr/sbin/nginx -g 'daemon on; master_process on;'  
ExecReload=/usr/sbin/nginx -g 'daemon on; master_process on;' -s reload  
ExecStop=-/sbin/start-stop-daemon --quiet --stop --retry QUIT/5 --pidfile /run/nginx.pid  
TimeoutStopSec=5  
KillMode=mixed  

[Install]  
WantedBy=multi-user.target  
```

--------------------------------

### Rebuild Client and Copy ENV (Standalone)

Source: https://docs.snailycad.org/docs/guides/env/how-to-properly-update-env

Run this command in standalone installations to rebuild the client and copy the .env file to the client and API before starting.

```bash
node scripts/copy-env.mjs --client --api && pnpm run build  

```

--------------------------------

### Enable and Start Nginx on Linux Boot

Source: https://docs.snailycad.org/docs/installations/reverse-proxies/nginx

Enables Nginx to start automatically on system boot and then starts the Nginx service immediately using systemd.

```bash
# Enable nginx on boot  
sudo systemctl enable nginx  
# Start nginx  
sudo systemctl start nginx  
```

--------------------------------

### Verify Node.js, npm, and pnpm Installation

Source: https://docs.snailycad.org/docs/guides/requirements/how-to-install-node-pnpm-npm-linux

Check the installed versions of Node.js, npm, and pnpm to confirm successful installation.

```bash
node -v  
npm -v  
pnpm -v  

```

--------------------------------

### Verify Git Installation

Source: https://docs.snailycad.org/docs/guides/requirements/how-to-install-git-linux

Run this command after installation to confirm that Git is successfully installed and check its version.

```bash
git --version
```

--------------------------------

### Start SnailyCAD Instance (Standalone)

Source: https://docs.snailycad.org/docs/guides/product/how-to-install-custom-fonts

Use this command to start your SnailyCAD instance if you are running it standalone.

```bash
pnpm run start

```

--------------------------------

### Start NGINX on Linux

Source: https://docs.snailycad.org/docs/installations/reverse-proxies/nginx

Starts the NGINX service using systemctl. This command requires superuser privileges.

```bash
sudo systemctl start nginx
```

--------------------------------

### Install Node.js and npm

Source: https://docs.snailycad.org/docs/guides/requirements/how-to-install-node-pnpm-npm-linux

Install Node.js and npm on your Ubuntu system using the apt package manager.

```bash
sudo apt install nodejs  

```

--------------------------------

### Install UFW Firewall on Linux

Source: https://docs.snailycad.org/docs/installations/reverse-proxies/nginx

Installs the Uncomplicated Firewall (UFW) on a Linux system by updating the package manager and then installing the ufw package.

```bash
# Update the package manager database  
sudo apt update  
# Install the ufw package  
sudo apt install ufw -y  
```

--------------------------------

### Start PostgreSQL Service

Source: https://docs.snailycad.org/docs/guides/requirements/how-to-install-postgresql-linux

Start the PostgreSQL service to enable database connections.

```bash
sudo systemctl start postgresql.service
```

--------------------------------

### Start SnailyCAD Instance (Docker)

Source: https://docs.snailycad.org/docs/guides/product/how-to-install-custom-fonts

Run this command to start your SnailyCAD instance if you are using Docker.

```bash
docker compose -f production.docker-compose.yml up -d

```

--------------------------------

### Start the Bot

Source: https://docs.snailycad.org/docs/discord-integration/discord-bot/updating

Launches the Discord bot application.

```bash
yarn start  

```

--------------------------------

### Install PM2 Globally

Source: https://docs.snailycad.org/docs/guides/how-to-start-with-pm2

Install the PM2 process manager globally using npm.

```bash
npm install pm2 -g  
```

--------------------------------

### Copy Environment Example File (Windows)

Source: https://docs.snailycad.org/docs/discord-integration/discord-bot

Copy the .env.example file to .env on Windows. This creates the configuration file that the bot will use.

```bash
copy .env.example .env  

```

--------------------------------

### Copy Environment Example File (Linux)

Source: https://docs.snailycad.org/docs/discord-integration/discord-bot

Copy the .env.example file to .env on Linux. This creates the configuration file that the bot will use.

```bash
cp .env.example .env  

```

--------------------------------

### Example .env File Configuration

Source: https://docs.snailycad.org/docs/installations/methods/docker

This is an example of a fully configured .env file for SnailyCADv4. Ensure all sensitive values like passwords and secrets are changed.

```dotenv
# Documentation can be found at: https://docs.snailycad.org/docs/installations  
  
# This is the password to the postgress database.  
POSTGRES_PASSWORD="Y8CURkTv"  
  
# This is the username to the postgress database.  
POSTGRES_USER="postgres"  
  
# The database host - Set as 'postgres' when using docker compose  
DB_HOST="postgres"  
  
# The database port - keep port as '5432' when using docker compose  
DB_PORT="5432"  
  
# The database name.  
POSTGRES_DB="snaily-cad-v4"  
  
# This is a random value to keep the CAD's cookies secured. Make sure to change this!  
JWT_SECRET="GxuPM0XmlxvCDX0QfZeqLSo0uvNm3FsEZN56JRZYNSU="  
  
# string of 32 characters long. Make sure to change this!  
# Generate one at: https://codebeautify.org/generate-random-string  
ENCRYPTION_TOKEN="BOqZR1ycU0zl6vEo64JgZB8BPtjcR7"  
  
# This is the URL/IP to your site where the CAD is hosted.  
# -> e.g. https://cad.mysite.com or http://99.99.00.190:3000  
CORS_ORIGIN_URL="https://cad.example.com"  
  
# The URL/IP to where the API is hosted.  
# -> e.g. https://cad-api.mysite.com/v1 or http://99.99.00.190:8080/v1  
NEXT_PUBLIC_PROD_ORIGIN="https://cad-api.example.com/v1"  
  
# only enter this value if you're using a domain!  
# domain should only be the domain, NOT including sub-domains  
# example: `DOMAIN="example.com"`  
DOMAIN="example.com"  
  
# "true" or "false"  
# Can only be enabled when having valid SSL (https) and a domain.  
SECURE_COOKIES_FOR_IFRAME="false"  
  
# The port of which the API will run on. Default: 8080  
# When using Docker, make sure to change this in the `production.docker-compose.yml` file too.  
PORT_API=8080  
  
# The port of which the client will run on. Default: 3000  
PORT_CLIENT=3000  
  
# Errors get reported to Linear (Project manager). This is done so errors can be fixed faster.  
TELEMETRY_ENABLED="true"  
  
# Do not change this.  
NODE_ENV="production"  
  
# Do not change this, unless you know what you're doing!  
DATABASE_URL=postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${DB_HOST}:${DB_PORT}/${POSTGRES_DB}?sslmode=prefer  

```

--------------------------------

### Start SnailyCAD within Screen

Source: https://docs.snailycad.org/docs/guides/how-to-start-with-screen

After creating the screen session and navigating to your SnailyCAD instance folder, run this command to start the application.

```bash
pnpm run start  
```

--------------------------------

### Install Dependencies with pnpm

Source: https://docs.snailycad.org/docs/migration/yarn-to-pnpm

After removing old modules and lock files, install project dependencies using pnpm.

```bash
pnpm install
```

--------------------------------

### Install Git on Debian/Ubuntu

Source: https://docs.snailycad.org/docs/guides/requirements/how-to-install-git-linux

Use this command to install the latest version of Git on Debian-based Linux distributions.

```bash
sudo apt install git
```

--------------------------------

### Start SnailyCAD with Docker Compose

Source: https://docs.snailycad.org/docs/installations/methods/docker

Starts the SnailyCAD application using Docker Compose. The first run will download all necessary services from Docker Hub.

```bash
docker compose -f production.docker-compose.yml up -d
```

--------------------------------

### Example .env File Configuration

Source: https://docs.snailycad.org/docs/guides/env/reference

This snippet shows a complete example of a .env file with various configuration settings for SnailyCAD, including database credentials, security tokens, and URL configurations. Ensure sensitive values like JWT_SECRET and ENCRYPTION_TOKEN are changed.

```env
# Documentation can be found at: https://docs.snailycad.org/docs/guides/env/reference  
  
# This is the password to the postgress database.  
POSTGRES_PASSWORD="Y8CURkTv"  
  
# This is the username to the postgress database.  
POSTGRES_USER="postgres"  
  
# The database host - Set as 'postgres' when using docker compose  
DB_HOST="localhost"  
  
# The database port - keep port as '5432' when using docker compose  
DB_PORT="5432"  
  
# The database name.  
POSTGRES_DB="snaily-cad-v4"  
  
# This is a random value to keep the CAD's cookies secured. Make sure to change this!  
JWT_SECRET="GxuPM0XmlxvCDX0QfZeqLSo0uvNm3FsEZN56JRZYNSU="  
  
# string of 32 characters long. Make sure to change this!  
# Generate one at: https://codebeautify.org/generate-random-string  
ENCRYPTION_TOKEN="BOqZR1ycU0zl6vEo64JgZB8BPtjcR7"  
  
# This is the URL/IP to your site where the CAD is hosted.  
# -> e.g. https://cad.mysite.com or http://99.99.00.190:3000  
CORS_ORIGIN_URL="https://cad.example.com"  
  
# The URL/IP to where the API is hosted.  
# -> e.g. https://cad-api.mysite.com/v1 or http://99.99.00.190:8080/v1  
NEXT_PUBLIC_PROD_ORIGIN="https://cad-api.example.com/v1"  
  
# only enter this value if you're using a domain!  
# domain should only be the domain, NOT including sub-domains  
# example: `DOMAIN="example.com"`  
DOMAIN="example.com"  
  
# "true" or "false"  
# Can only be enabled when having valid SSL (https) and a domain.  
SECURE_COOKIES_FOR_IFRAME="false"  
  
# The port of which the API will run on. Default: 8080  
# When using Docker, make sure to change this in the `production.docker-compose.yml` file too.  
PORT_API=8080  
  
# The port of which the client will run on. Default: 3000  
PORT_CLIENT=3000  
  
# Do not change this.  
NODE_ENV="production"  
  
# Do not change this, unless you know what you're doing!  
DATABASE_URL=postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${DB_HOST}:${DB_PORT}/${POSTGRES_DB}?sslmode=prefer  
```

--------------------------------

### Install PostgreSQL 16

Source: https://docs.snailycad.org/docs/guides/requirements/how-to-install-postgresql-linux

Update apt packages and install PostgreSQL 16 and its contrib package.

```bash
sudo apt update && sudo apt install -y postgresql-16 postgresql-contrib
```

--------------------------------

### Start SnailyCADv4 with PM2

Source: https://docs.snailycad.org/docs/guides/how-to-start-with-pm2

Start the SnailyCADv4 application as a background process using PM2, naming the process 'SnailyCADv4'.

```bash
pm2 start npm --name SnailyCADv4 -- run start
```

--------------------------------

### Start Nginx Automatically on Windows

Source: https://docs.snailycad.org/docs/installations/reverse-proxies/nginx

A batch script to check if Nginx is running and start it if it's not. This script is intended to be used with Windows Task Scheduler to ensure Nginx starts on boot.

```batch
@ECHO OFF  
REM Start Nginx  
tasklist /FI "IMAGENAME eq nginx.exe" 2>NUL | find /I /N "nginx.exe">NUL  
IF NOT "%ERRORLEVEL%"=="0" (  
   REM Nginx is NOT running, so start it  
   start nginx  
   ECHO Nginx started.  
) else (  
   ECHO Nginx is already running.  
)
```

--------------------------------

### Start SnailyCAD Application

Source: https://docs.snailycad.org/docs/installations/methods/standalone

Start the SnailyCADv4 application after completing the build process. For background execution, consider using PM2.

```bash
pnpm run start
```

--------------------------------

### Install Certbot and Nginx Plugin on Linux

Source: https://docs.snailycad.org/docs/installations/reverse-proxies/nginx

Installs Certbot and its Nginx plugin using apt for Debian/Ubuntu-based systems.

```bash
sudo apt install certbot python3-certbot-nginx
```

--------------------------------

### Start SnailyCAD Client and API

Source: https://docs.snailycad.org/docs/developer/batch-starter

Use this command in a batch file to start both the SnailyCAD client and API simultaneously when using the standalone version. Ensure you are in the `snaily-cadv4` directory.

```batch
pnpm run start  

```

--------------------------------

### Install NGINX on Debian-based Linux

Source: https://docs.snailycad.org/docs/installations/reverse-proxies/nginx

Installs the NGINX package using the apt package manager. Ensure the package manager database is updated first.

```bash
sudo apt update
sudo apt install nginx -y
```

--------------------------------

### Start SnailyCAD (Docker)

Source: https://docs.snailycad.org/docs/guides/env/how-to-properly-update-env

Run this command to start your SnailyCAD instance in detached mode after updating the .env file with Docker.

```bash
docker compose -f production.docker-compose.yml up -d  

```

--------------------------------

### Navigate to Documents Folder (Windows)

Source: https://docs.snailycad.org/docs/discord-integration/discord-bot

Change the current directory to the Documents folder on Windows. This is a prerequisite for installing the bot.

```bash
cd Documents  

```

--------------------------------

### Create a Screen Session

Source: https://docs.snailycad.org/docs/guides/how-to-start-with-screen

Use this command to create a new screen session. You can name the session anything you like, 'snailycad' is just an example.

```bash
screen -S snailycad  
```

--------------------------------

### Rebuild Client and Copy ENV (Docker)

Source: https://docs.snailycad.org/docs/guides/env/how-to-properly-update-env

Execute this command for Docker installations to rebuild the client and copy the .env file to the client and API.

```bash
node scripts/copy-env.mjs --client --api && docker compose -f production.docker-compose.yml build  

```

--------------------------------

### Add Node.js Repository

Source: https://docs.snailycad.org/docs/guides/requirements/how-to-install-node-pnpm-npm-linux

Add the Node.js 22.x repository to your system to enable installation of the latest Node.js version.

```bash
curl -fsSL https://deb.nodesource.com/setup_22.x | sudo -E bash -  

```

--------------------------------

### Start SnailyCAD Bot with PM2

Source: https://docs.snailycad.org/docs/discord-integration/discord-bot

Start the SnailyCAD bot using PM2. This command runs the bot as a managed process, allowing for easier control and monitoring.

```bash
pm2 start yarn --name "snailycad-bot" -- start  

```

--------------------------------

### Navigate to Home Folder (Linux)

Source: https://docs.snailycad.org/docs/discord-integration/discord-bot

Change the current directory to the user's home folder on Linux. This is a prerequisite for installing the bot.

```bash
cd /home/$(whoami)  

```

--------------------------------

### Install PM2 for Process Management

Source: https://docs.snailycad.org/docs/discord-integration/discord-bot

Install PM2 globally using npm. PM2 is a process manager that can be used to keep the SnailyCAD bot running.

```bash
npm install -g pm2  

```

--------------------------------

### Ensure sna-calltow Script

Source: https://docs.snailycad.org/docs/fivem-integrations/scripts/sna-calltow

Add this line to your server.cfg to ensure the sna-calltow script is loaded when the server starts.

```cfg
ensure sna-calltow
```

--------------------------------

### Example EADDRINUSE Error Log

Source: https://docs.snailycad.org/docs/errors/port-inuse

This is an example of the error log you might see when the EADDRINUSE error occurs. It details the system call, address, and port that are in use.

```text
Error: listen EADDRINUSE: address already in use 0.0.0.0:3000  
at Server.setupListenHandle [as _listen2] (node:net:1372:16)  
at listenInCluster (node:net:1420:12)  
at doListen (node:net:1559:7)  
at processTicksAndRejections (node:internal/process/task_queues:84:21) {  
  code: 'EADDRINUSE',  
  errno: -4091,  
  syscall: 'listen',  
  address: '0.0.0.0',  
  port: 3000  
}  

```

--------------------------------

### Enter Bot Directory

Source: https://docs.snailycad.org/docs/discord-integration/discord-bot

Navigate into the cloned snailycad-bot directory. This is necessary to access the bot's files for further configuration and installation.

```bash
cd snailycad-bot  

```

--------------------------------

### Update Package List

Source: https://docs.snailycad.org/docs/guides/requirements/how-to-install-node-pnpm-npm-linux

Update your system's package list before installing new software.

```bash
sudo apt update  

```

--------------------------------

### Generate SSL Certificates with Certbot for Nginx

Source: https://docs.snailycad.org/docs/installations/reverse-proxies/nginx

Launches Certbot to automatically generate and install SSL certificates for Nginx.

```bash
certbot --nginx
```

--------------------------------

### Ensure sna-alpr

Source: https://docs.snailycad.org/docs/fivem-integrations/scripts/sna-alpr

Add this line to your server.cfg to ensure the sna-alpr resource is started.

```cfg
ensure sna-alpr
```

--------------------------------

### Update server.cfg for Live Map

Source: https://docs.snailycad.org/docs/fivem-integrations/live-map

Add these lines to your server.cfg file to ensure the live_map resource is properly configured and started.

```cfg
set socket_port 30121

ensure sna-live-map
```

--------------------------------

### Build Docker Compose Project

Source: https://docs.snailycad.org/docs/installations/methods/docker

Builds the Docker container for SnailyCAD, installing dependencies and packages. This command must be run after any changes to the .env file.

```bash
docker compose -f production.docker-compose.yml build
```

--------------------------------

### Build SnailyCAD Packages

Source: https://docs.snailycad.org/docs/installations/methods/standalone

Build all necessary packages and applications for SnailyCAD, including the client, schemas, config, and types. This process may take several minutes.

```bash
pnpm run build
```

--------------------------------

### Copy Environment File

Source: https://docs.snailycad.org/docs/installations/methods/standalone

Copy the configured .env file to the client and API directories using the provided script. This step is crucial after correctly configuring all environment variables.

```bash
node scripts/copy-env.mjs --client --api
```

--------------------------------

### Connect to PostgreSQL Database

Source: https://docs.snailycad.org/docs/guides/requirements/how-to-install-postgresql-linux

Connect to the default PostgreSQL database using the psql command-line tool.

```bash
psql -d postgres
```

--------------------------------

### Verify Nginx Configuration (Windows)

Source: https://docs.snailycad.org/docs/installations/reverse-proxies/nginx

Command to test the Nginx configuration syntax on Windows.

```bash
cd C:\nginx
nginx -t
```

--------------------------------

### Update Dependencies

Source: https://docs.snailycad.org/docs/discord-integration/discord-bot/updating

Installs or updates project dependencies defined in package.json.

```bash
yarn  

```

--------------------------------

### Create Docker Network

Source: https://docs.snailycad.org/docs/installations/methods/docker

Sets up a Docker network for SnailyCAD services to communicate.

```bash
docker network create cad_web
```

--------------------------------

### Switch to Postgres User

Source: https://docs.snailycad.org/docs/guides/requirements/how-to-install-postgresql-linux

Switch to the 'postgres' user to avoid 'role "root" does not exist' errors when connecting to the database.

```bash
sudo -u postgres -i
```

--------------------------------

### Update Font Family in CSS

Source: https://docs.snailycad.org/docs/guides/product/how-to-install-custom-fonts

Replace the existing font-family declaration in `apps/client/src/styles/fonts.scss` to use your newly installed custom font.

```scss
html,
body,
#map-calls,
.leaflet-container {
  font-family: "Assistant", sans-serif;
}

```

```scss
html,
body,
#map-calls,
.leaflet-container {
  font-family: "MyFontNameHere", sans-serif;
}

```

--------------------------------

### Rebuild SnailyCAD Client (Standalone)

Source: https://docs.snailycad.org/docs/guides/product/how-set-custom-sounds

Run this command to rebuild the client when SnailyCAD is running standalone.

```bash
pnpm run build  

```

--------------------------------

### Build the Bot

Source: https://docs.snailycad.org/docs/discord-integration/discord-bot/updating

Compiles or bundles the bot's code for production.

```bash
yarn build  

```

--------------------------------

### Verify Nginx Configuration (Linux)

Source: https://docs.snailycad.org/docs/installations/reverse-proxies/nginx

Command to test the Nginx configuration syntax on Linux.

```bash
nginx -t
```

--------------------------------

### Ensure sna-sync Script

Source: https://docs.snailycad.org/docs/fivem-integrations/scripts/sna-sync

Add this line to your `server.cfg` to ensure the `sna-sync` script is loaded.

```cfg
ensure sna-sync  

```

--------------------------------

### Navigate to SnailyCAD Directory

Source: https://docs.snailycad.org/docs/guides/how-to-start-with-pm2

Change the current directory to your SnailyCAD instance folder.

```bash
cd snaily-cadv4  
```

--------------------------------

### Reset User Password

Source: https://docs.snailycad.org/docs/guides/recovery-tools

Resets a user's password using bcrypt encryption. Requires the pgcrypto extension to be installed. Replace 'NEW_PASSWORD' and 'USERNAME_HERE' with actual values.

```sql
CREATE EXTENSION IF NOT EXISTS pgcrypto;  
UPDATE public."User"  
SET password = crypt('NEW_PASSWORD', gen_salt('bf'))  
WHERE username = 'USERNAME_HERE';  

```

--------------------------------

### Enable Regular Login for Emergency Access

Source: https://docs.snailycad.org/docs/guides/recovery-tools

Follow these steps in the admin tool to enable username/password login when other authentication methods fail.

```bash
1. Run admin tool  
2. Select "Authentication Methods"  
3. Enable "ALLOW_REGULAR_LOGIN"  
4. Users can now log in with username/password  
```

--------------------------------

### Perform HTTP Request to SnailyCAD API (Lua)

Source: https://docs.snailycad.org/docs/developer/public-api

This Lua snippet demonstrates how to make an HTTP GET request to the SnailyCAD API, including the API token in the headers. Replace 'URLHERE' and 'TOKENHERE' with your actual API URL and token.

```lua
local API_URL = "URLHERE"  
local API_TOKEN = "TOKENHERE"  
local API_TOKEN_HEADER_NAME = "snaily-cad-api-token"  
  
PerformHttpRequest(  
    API_URL .. "admin/values/vehicle?paths=weapon,gender,ethnicity",  
    function(errorCode, resultData, resultHeaders)  
        print("Returned error code:" .. tostring(errorCode))  
        print("Returned data:" .. tostring(resultData))  
        print("Returned result Headers:" .. tostring(resultHeaders))  
    end,  
    "GET",  
    json.encode("{}"),  
    {  
        [API_TOKEN_HEADER_NAME] = API_TOKEN,  
        ["Content-Type"] = "application/json"  
    }
)

```

--------------------------------

### Fetch Data from SnailyCAD API (JavaScript)

Source: https://docs.snailycad.org/docs/developer/public-api

Use this JavaScript snippet to fetch various administrative values like vehicles, weapons, genders, and ethnicities from the SnailyCAD API. Ensure you have the 'node-fetch' package installed and the API token and URL configured in 'server.cfg'.

```javascript
const fetch = require("node-fetch");  
  
// get the token from `server.cfg`  
const token = GetConvar("snailycad_v4_api_token");  
// example.com/v1  
const apiUrl = GetConvar("snailycad_v4_api_url");  
  
// this must be: "snaily-cad-api-token"  
const API_TOKEN_HEADER_NAME = "snaily-cad-api-token";  
  
const USER_API_TOKEN_HEADER_NAME = "snaily-cad-user-api-token";  
  
// send a request with the global CAD's API Token  
async function getValuesFromCAD() {  
  // get all the vehicles, weapons, genders and ethnicities  
  const response = await fetch(`${apiUrl}/admin/values/vehicle?paths=weapon,gender,ethnicity`, {  
    headers: {  
      // send the token via headers.  
      [API_TOKEN_HEADER_NAME]: token,  
    },  
  });  
  const json = response.ok && (await response.json());  
  
  if (json) {  
    console.log("data from API: ", { json });  
  }  
}

```

```javascript
// send a request with the user's API token.  
// Note: only available from version 1.0.0-beta.89  
async function getMyCitizens() {  
  // get all the citizens of the authenticated user  
  const response = await fetch(`${apiUrl}/citizen`, {  
    headers: {  
      // send the token via headers.  
      [USER_API_TOKEN_HEADER_NAME]: "user api token",  
    },  
  });  
  const json = response.ok && (await response.json());  
  
  if (json) {  
    console.log("data from API: ", { json });  
  }  
}

```

--------------------------------

### Rebuild SnailyCAD Client (Docker)

Source: https://docs.snailycad.org/docs/guides/product/how-set-custom-sounds

Use this command to rebuild the client when SnailyCAD is running with Docker.

```bash
docker compose -f production.docker-compose.yml build  

```

--------------------------------

### Clone and Run Recovery Script (Linux/macOS)

Source: https://docs.snailycad.org/docs/guides/recovery-tools

Use these commands to clone the recovery script repository, make it executable, and run it on Linux or macOS.

```bash
git clone https://github.com/EWANZO101/sh.git  
cd sh  
chmod +x full-snailycad-recovery.sh  
./full-snailycad-recovery.sh  
```

--------------------------------

### Disable Whitelist for Open Registration

Source: https://docs.snailycad.org/docs/guides/recovery-tools

Instructions to disable the whitelist, allowing open registration to the server.

```bash
1. Run admin tool  
2. Select "Whitelist Management"  
3. Choose "Disable Whitelist"  
4. Confirm action  
5. Server now allows open registration  
```

--------------------------------

### Update Environment Variables and Build Project

Source: https://docs.snailycad.org/docs/features/2fa

After modifying the .env file, run these commands to update environment variables and rebuild the client and API for the changes to take effect.

```bash
node scripts/copy-env.mjs --client --api
pnpm turbo run build --filter=@snailycad/client
```

--------------------------------

### Enable UFW Firewall

Source: https://docs.snailycad.org/docs/installations/reverse-proxies/nginx

Enables the Uncomplicated Firewall (UFW). You will be prompted to confirm.

```bash
sudo ufw enable
```

--------------------------------

### Successful Nginx Configuration Test (Linux)

Source: https://docs.snailycad.org/docs/installations/reverse-proxies/nginx

Output indicating a successful Nginx configuration test on Linux.

```text
nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
nginx: configuration file /etc/nginx/nginx.conf test is successful
```

--------------------------------

### List All Screen Sessions

Source: https://docs.snailycad.org/docs/guides/how-to-start-with-screen

This command allows you to view all currently active screen sessions.

```bash
screen -list  
```

--------------------------------

### Check Node.js Version

Source: https://docs.snailycad.org/docs/errors/invalid-node-version

Use this command to verify your current Node.js version. Ensure it is v18.x or higher.

```bash
node -v
```

--------------------------------

### Successful Nginx Configuration Test (Windows)

Source: https://docs.snailycad.org/docs/installations/reverse-proxies/nginx

Output indicating a successful Nginx configuration test on Windows.

```text
nginx: the configuration file C:\nginx\conf\nginx.conf syntax is ok
nginx: configuration file C:\nginx\conf\nginx.conf test is successful
```

--------------------------------

### View PM2 Process Logs

Source: https://docs.snailycad.org/docs/guides/how-to-start-with-pm2

Display the logs for all PM2-managed processes.

```bash
pm2 logs
```

--------------------------------

### Complete Nginx Configuration with Client and API Proxies

Source: https://docs.snailycad.org/docs/installations/reverse-proxies/nginx

A full Nginx configuration file including reverse proxies for both the SnailyCAD API and client, along with default server configuration.

```nginx
#user  nobody;
worker_processes  1;

#error_log  logs/error.log;
#error_log  logs/error.log  notice;
#error_log  logs/error.log  info;

#pid        logs/nginx.pid;


events {
    worker_connections  1024;
}


http {
    include       mime.types;
    default_type  application/octet-stream;
    server_names_hash_bucket_size 64;
    client_max_body_size 100M;

    sendfile        on;
    keepalive_timeout  65;
    gzip  on;

    # SnailyCAD API Reverse Proxy
    server {
      # Replace `example.com` with your domain name.
      server_name cad-api.example.com;

      location / {
        proxy_pass http://localhost:8080; # The API port of SnailyCAD's API (Default: 8080)
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection 'upgrade';
        proxy_set_header Host $host;
        proxy_cache_bypass $http_upgrade;
      }


      # Security headers
      add_header X-XSS-Protection          "1; mode=block" always;
      add_header X-Content-Type-Options    "nosniff" always;
      add_header Referrer-Policy           "no-referrer" always;
      add_header Strict-Transport-Security "max-age=31536000; includeSubDomains; preload" always;
      add_header X-DNS-Prefetch-Control on;
      add_header Cross-Origin-Resource-Policy "cross-origin";

      # keep this as-is unless you know what you're doing.
      listen 80;
    }


    # SnailyCAD Client Reverse Proxy
    server {
      # Replace `example.com` with your domain name.
      server_name cad.example.com;

      location / {
        proxy_pass http://localhost:3000; # The API port of SnailyCAD's client (Default: 3000)
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection 'upgrade';
        proxy_set_header Host $host;
        proxy_cache_bypass $http_upgrade;
      }


      # Security headers
      add_header X-XSS-Protection          "1; mode=block" always;
      add_header X-Content-Type-Options    "nosniff" always;
      add_header Referrer-Policy           "no-referrer" always;
      add_header Strict-Transport-Security "max-age=31536000; includeSubDomains; preload" always;
      add_header X-DNS-Prefetch-Control on;
      add_header Cross-Origin-Resource-Policy "same-site";

      # keep this as-is unless you know what you're doing.
      listen 80;
    }

    server {
        listen       80;
        server_name  localhost;

        location / {
            root   html;
            index  index.html index.htm;
        }

        error_page   500 502 503 504  /50x.html;
        location = /50x.html {
            root   html;
        }
    }
}
```

--------------------------------

### Add Steam API Key to .env

Source: https://docs.snailycad.org/docs/steam-integration/steam-authentication

Add this line to the bottom of your SnailyCAD .env file and replace the empty string with your generated Steam API key.

```env
STEAM_API_KEY=""
```

--------------------------------

### Download and Run Autoupdater Script

Source: https://docs.snailycad.org/docs/installations/updating/methods/autoupdater

This sequence downloads the autoupdater script and then executes it. Ensure you are in the root directory of your SnailyCAD instance and have updated your .env file if necessary.

```bash
curl https://raw.githubusercontent.com/SnailyCAD/autoupdater/main/dist/index.js > autoupdater.mjs  
  
node autoupdater.mjs  

```
Tokens:
Raw