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.
-
Clone the repository
git clone https://github.com/Hans-Vader/squad-dev-environment.git
cd sqaud-dev-environment -
Adjust configuration files
Copy
.env.distto.envand adjust the values for your environment:cp .env.dist .env
Copy
squadjs-config.json.disttosquadjs-config.jsonand adjust the values for your environment:cp squadjs-config.json.dist squadjs-config.json
Copy
Admins.cfg.disttoAdmins.cfgand adjust the values for your environment:cp Admins.cfg.dist Admins.cfg
-
Start Docker containers
docker compose up -d
-
Check server status
docker compose ps
This project is licensed under the GNU General Public License v3.0.