Skip to content

Hans-Vader/squad-dev-environment

Repository files navigation

Squad Dev Environment

This repository provides a development environment for Squad servers and SquadJS. It uses Docker and Docker Compose to easily run a dedicated Squad server, SFTP, MariaDB, and SquadJS locally or on a server. There are two docker-compose.yml files: one for a Squad server with a SFTP to make the log files accessible and another that includes SquadJS and a MariaDB.

Requirements

Setup

  1. Clone the repository

    git clone https://github.com/Hans-Vader/squad-dev-environment.git
    cd sqaud-dev-environment
  2. Adjust configuration files

    Copy .env.dist to .env and adjust the values for your environment:

    cp .env.dist .env

    Copy squadjs-config.json.dist to squadjs-config.json and adjust the values for your environment:

    cp squadjs-config.json.dist squadjs-config.json

    Copy Admins.cfg.dist to Admins.cfg and adjust the values for your environment:

    cp Admins.cfg.dist Admins.cfg
  3. Start Docker containers

    docker compose up -d
  4. Check server status

    docker compose ps

License

This project is licensed under the GNU General Public License v3.0.

About

A simple setup for running a squad server and sqaudjs

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published