🌎 Motivation

Start Call of Duty 2 server from nothing with just 2 commands and 3 minutes waiting. 🤩

Setting up Call of Duty 2 server requires a lot of configuration and can be a pain. Use this repo to automate process of provisioning and configuring. It utilizes terraform and does everything for you. The CoD2 server will be launched inside docker. The docker image used is maintained here: cod2-docker.

Thanks a lot to whole killtube.org community for open-source developing. 🥰

🚀 Features

Creates key pair and stores locally
Configures AWS security groups
Creates EC2 instance
Performs initalization on provided machine
Installs required packages like: aws cli, unzip
Setups docker engine and docker-compose
Creates structure for CoD2 servers
Syncs S3 bucket with CoD2 server files
Setups files so you can run either 1.0, 1.2 and 1.3 version
Provides docker-compose files
Starts reverse-proxy
Configures CoD2 FastDL for reverse-proxy
Starts MySQL server
Starts phpmyadmin service
Starts sample CoD2 server

📝 Pre-requirements

terraform CLI
AWS account (aws_access_key_id + aws_secret_access_key with S3 reader permission)
CoD2 server files uploaded to S3, bucket should look like this:

S3 bucket
├── 1_0
│   ├── iw_00.iwd
│   ├── iw_01.iwd
│   ├── iw_02.iwd
│   ├── (...)
│   ├── iw_13.iwd
│   ├── iw_14.iwd
│   └── localized_english_iw99.iwd
└── 1_3
    └── iw_15.iwd

localized_english_iw99.iwd comes from this IzNoGoD's post

🤷🏻‍♂️ How to use?

You have two options:

Option A: You have nothing set up - provide whole insfrastructure, install required packages, configure, deploy and run CoD2 servers.

Option B: You already have clean VPS machine - do everything above without creating new infrastructure

😌 Option A: CoD2 as code approach

terraform apply # See description below

# SSH connect
./scripts/connect.sh
# MySQL connect
./scripts/mysql.sh

To get the reverse-proxy (fastdl and phpmyadmin) working remember to configure DNS A record for subdomains fastdl.yourdomain.com and pma.yourdomain.com.

🖥️ Option B: Configure existing VPS

Create key for accessing server (skip if already exists)

export COD2_AS_CODE_SERVER_ADDRESS=34.246.184.216
export COD2_AS_CODE_KEY_NAME=mykey

ssh-keygen -t ed25519 -b 2048 -f ~/.ssh/$COD2_AS_CODE_KEY_NAME -N "" # Generate the key
ssh-copy-id -i ~/.ssh/$COD2_AS_CODE_KEY_NAME.pub ubuntu@$COD2_AS_CODE_SERVER_ADDRESS # Copy the key to the machine

Upload the necessary scripts on the machine

sudo scp -r -i ~/.ssh/$COD2_AS_CODE_KEY_NAME ./setup/* ubuntu@$COD2_AS_CODE_SERVER_ADDRESS:~

Expected structure:

/home/ubuntu
├── lamp
│   ├── docker-compose.yml.envsubst
│   └── html
│       └── index.php
├── reverse-proxy
│   ├── docker-compose.yml
│   └── nginx.conf.envsubst
├── scripts
│   ├── parts
│   │   ├── cod2.sh
│   │   ├── envsubst.sh
│   │   └── requirements.sh
│   └── start.sh
└── servers
    └── nl-example
        ├── nl
        │   ├── sample_fx.iwd
        │   └── server.cfg.envsubst
        └── docker-compose.yml

Run following commands

ssh -i ~/.ssh/$COD2_AS_CODE_KEY_NAME ubuntu@$COD2_AS_CODE_SERVER_ADDRESS # Connect to the machine

# Run the setup script if you want to get server files from your S3 (fully automatic installation)
~/scripts/start.sh \
    --mysql_root_password=changemeplease \
    --aws_access_key_id=AAAAAAAAAAAAAAAAAAAA \
    --aws_secret_access_key=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX \
    --s3_bucket_name=s3://cod2-server-files \
    --s3_bucket_region=eu-central-1 \
    --domain=yourdomain.com \
    --email=you@domain.com # Used for Let's encrypt SSL cert retrieval

# Or else upload CoD2 base server files using FTP (part manual installation)
~/scripts/start.sh \
    --mysql_root_password=changemeplease \
    --domain=yourdomain.com \
    --email=you@domain.com # Used for Let's encrypt SSL cert retrieval


# SSH connect
./scripts/connect.sh
# MySQL connect
./scripts/mysql.sh

Secure your server

This is optional but highly recommended. Ensure you enable traffic only to services that you want to expose.

sudo ufw default deny incoming
sudo ufw default allow outgoing
sudo ufw allow ssh
sudo ufw allow http
# sudo ufw allow 3307/tcp # MySQL / uncomment this line if you want to allow for remote access
sudo ufw allow 28960:28980/tcp # CoD2 servers TCP
sudo ufw allow 28960:28980/udp # CoD2 servers UDP
echo "y" | sudo ufw enable
sudo ufw status

Connection to phpmyadmin or fastdl is not open by default because the traffic will go throught reverse-proxy. Connection to mysql is not open by default because services running on the server will comunicate with it using localhost network.

To get the reverse-proxy (fastdl and phpmyadmin) working remember to configure DNS A record for subdomains fastdl.yourdomain.com and pma.yourdomain.com. It's recommended to also configure a firewall.

🆕 Updating or creating CoD2 servers

You can use this repo also for creating new servers and uploading the newest version of your mod. Let's say you want to update nl-example server. Place all the files that you want inside setup/servers/nl-example. Then run the command ./scripts/sync_server.sh nl-example.

Remember changes applied to CoD servers are applied after map restart. To do it use RCON command rcon map_rotate. If you however need to restart the whole server you can do it by firstly connecting to the machine with ./scripts/connect.sh and then navigating to the folder cd ~/cod2/servers/nl-example and executing docker-compose down && docker-compose up -d.

🙋🏻‍♂️ What's the structure after installation

├── cod2
│   ├── Library
│   ├── main
│   │   ├── 1_0
│   │   │   ├── iw_00.iwd
│   │   │   ├── iw_01.iwd
│   │   │   ├── iw_02.iwd
│   │   │   ├── (...)
│   │   │   ├── iw_13.iwd
│   │   │   ├── iw_14.iwd
│   │   │   └── localized_english_iw99.iwd
│   │   └── 1_3
│   │       ├── iw_00.iwd
│   │       ├── iw_01.iwd
│   │       ├── iw_02.iwd
│   │       ├── (...)
│   │       ├── iw_14.iwd
│   │       ├── iw_15.iwd
│   │       └── localized_english_iw99.iwd
│   └── servers
│       └── nl-example
│           ├── docker-compose.yml
│           └── nl
│               ├── maps
│               │   └── mp
│               │       └── gametypes
│               │           └── tdm.gsc
│               ├── sample_fx.iwd
│               └── server.cfg.envsubst
├── lamp
│   ├── docker-compose.yml
│   └── html
│       └── index.php
├── reverse-proxy
│   ├── docker-compose.yml
│   └── nginx.conf
└── scripts
    ├── parts
    │   ├── cod2.sh
    │   ├── envsubst.sh
    │   └── requirements.sh
    └── start.sh

💽 Database restore

After everything is created you can restore your database using this command.

mysql -h yourdomain.com -P 3307 -u root -p'changemeplease' --database=db < backup.sql

⏱️ Crontab

Enable servers at VPS startup and create schedule for database backup.

cat << EOF > mycron
@reboot bash -c 'cd /home/ubuntu/db && docker-compose up -d'
@reboot bash -c 'cd /home/ubuntu/phpmyadmin && docker-compose up -d'
@reboot bash -c 'cd /home/ubuntu/reverse-proxy && docker-compose up -d'
@reboot bash -c '/home/ubuntu/cod2/servers/nl-cod2-zom/restart.sh detach'
0 3 * * * /home/ubuntu/db/backup.sh
0 3 * * 2 bash -c 'cd /home/ubuntu/reverse-proxy && docker-compose run --rm certbot && docker-compose exec -T reverse-proxy nginx -s reload'
EOF
crontab mycron
rm mycron

🛣️ Roadmap

✅ [terraform] - Enable communication with server using Security Groups
✅ [terraform] - Generate key for accessing server with SSH
✅ [terraform] - Extend the default storage for EC2
✅ [setup.sh] - Create setup.sh script, with required arguments
✅ [setup.sh] - Install required libs for libcod compilation, compile libcod
✅ [setup.sh] - Sync CoD2 files with S3
✅ [terraform] - Execute setup.sh script on remote machine
✅ [start.sh] - Create start.sh script, with required parameters
✅ [start.sh] - Initalize server files - copy from outside source
✅ [start.sh] - Add support for 1.3 version
✅ [start.sh] - Create structure for project
✅ [terraform] - Copy start.sh to remote instance
✅ [terraform] - Execute start.sh on remote instance
✅ [docker] - Run server inside Docker instead of screen
✅ [docker] - Install LAMP stack
✅ [docker] - Configure FastDL
✅ [sync_server.sh] - Create script for syncing new version of server
✅ [libcod] - Change voron00 to zk version of libcod
✅ [docker] - Install reverse-proxy, add subdomain configuration for FastDL and phpmyadmin
✅ [start.sh] - Dynamic domain setup
✅ [docker] - certbot with automatic SSL certificate

rutkowski-tomasz/cod2-as-code