Palworld Server Infrastructure Terraform module.

• Palworld dedicated server docs https://tech.palworldgame.com/optimize-game-balance

I do this in my free time. Consider donating to keep the project going and motivate me to maintain the repo, add new features, etc :)

Support on Patreon

Support on BuyMeACoffee

Subscribe on YouTube

This module allows you to quickly deploy an Palworld server on AWS.

• Palworldrunning on Ubuntu
• The ability to use an existing PalWorldSettings.ini
• PalWorldSettings.ini settings are configurable inputs for creating a brand new configuration
• Ability to store backups in S3 at a defined interval
• Ability to start from existing save data
• AWS SSM or SSH connectivity

You must have the following to use this Terraform module:

• Terraform version >= 1.5.0 - Install Terraform
• An AWS account

1. Create a file named main.tf
2. Add the following as a minimum. See all available inputs in the "Inputs" section of this README. Inputs not defined will use their default values.

module "palworld" {
  source  = "TheSudoYT/palworld/aws"

  instance_type                 = "t3.xlarge"
  create_ssh_key                = true
  ssh_public_key                = "../../palworld_public_key.pub"
  server_name                   = "palworld-on-aws"
  server_player_max_num         = 32
}

3. Choose your inputs - PalWorldSettings.ini inputs use default values unless you provide a value OTHER than the default value. Palworld will use the settings from a custom PalWorldSettings.ini file if you choose to use one. Modifying an input that is a PalWorldSettings.ini setting while also using a custom PalWorldSettings.ini file will result ONLY the values in your custom .ini file being used.

4. Initialize Terraform - Run terraform init to download the module and providers.
5. Create the Palworld server and Infrastructure - Run terraform apply to start deploying the infrastructure.

The terraform apply will complete, but the server will not appear in the server list until this completes. You can SSH into your server ssh -i my_palworld_key.pem [email protected] and use journalctl -xu cloud-final to monitor the install. See the troubleshooting section of the README if you continue to have problems.

This module offers an optional backup feature, designed to safeguard your Pal/Saved/SaveGame directory by periodically copying it to an Amazon S3 bucket. When enabled, the backup feature automatically archives the specified directory to a designated S3 bucket at intervals defined by a cron expression. The retention period of these backups in S3 is controlled by the s3_bucket_backup_retention parameter, allowing for cost-effective storage management.

2 Files will be created on the Palworld server; palworld_backup_script.sh on install and palworld_backup_log.log AFTER the first backup job runs.

The backup should be visible in the AWS S3 bucket after the first specified backup interval time frame passes.

You can use an existing PalWorldSettings.ini so that the server starts with your custom settings. The following inputs are required to do this:

• Using the S3 option will instruct terraform to create an S3 bucket along with an EC2 instance profile that will have permissions to assume an IAM role that is also created. This role contains a policy to allow only the EC2 instance to access the S3 bucket to download PalWorldSettings.ini. This also instructs the user_data script that runs when the server starts to download PalWorldSettings.ini from that S3 bucket and place it in /palworld-server/Pal/Saved/Config/LinuxServer/PalWorldSettings.ini

• Using the GitHub option will simply instruct the user_data script that runs when the server starts to download PalWorldSettings.ini to the server and place it in /palworld-server/Pal/Saved/Config/LinuxServer/PalWorldSettings.ini

This guide outlines essential processes for starting from existing save data, restoring from backups, or migrating servers using this Terraform module. It emphasizes the importance of the DedicatedServerName setting and provides instructions for using both local and S3 bucket backups.

Before proceeding with backup or restoration processes, you must obtain the DedicatedServerName value from your old Palworld server's GameUserSettings.ini file. This value is crucial as it corresponds to the directory name containing your .sav files on the old server.

[!DANGER] It is mandatory to provide the DedicatedServeName from the old Pal/Saved/Config/LinuxServer/GameUserSettings.ini file. This is also the name of the directory from the old server that contained your .sav files.

Set backup_files_storage_type = "s3" if you have an AWS s3 bucket somewhere with the backups files already in it. Please note the warning below about the REQUIRED file structure of the bucket. Terraform and user_data are opinionated in how they retrieve and place these files, so you must adhere to this structure.

Set backup_files_storage_type = "local" if the save files are on your local host PC. Please note the warning below about the REQUIRED file structure of the bucket. Terraform and user_data are opinionated in how they retrieve and place these files, so you must adhere to this structure.

Required local file structure

• backup_files_storage_type = "local" will instruct terraform to create an S3 bucket named palworld-bootstrap-local-saves-<region>-<accID> and upload the save files from your local PC backup_files_local_path directory specified to that bucket. The user_data script on the EC2 instance will download the files from that S3 bucket when the server starts and place them in the /palworld-server/Pal/Saved/SaveGames/0/<dedicated_server_name_hash> directory.

• backup_files_storage_type = "s3" Is informing terraform that you have an existing S3 bucket somewhere that contains the save game data. The EC2 user_data script will attempt to sync the root of that S3 bucket with the SaveGames/0/<dedicated_server_name_hash> directory. It will also attempt to sync the S3 buckets Players folder to SaveGames/0/<dedicated_server_name_hash>/Players That is why it is important that the objects be uncompressed and in the proper structure.

Relevant inputs:

  start_from_backup         = true
  backup_files_storage_type = "local"
  dedicated_server_name_hash = "FA8C44A6FA46436AAAE4D414C4214B25"
  backup_files_local_path   = "../../assets"

Relevant inputs:

  start_from_backup         = true
  backup_files_storage_type = "s3"
  dedicated_server_name_hash = "FA8C44A6FA46436AAAE4D414C4214B25"
  existing_backup_files_bootstrap_bucket_arn  = "arn:aws:s3:::palworld-existing-s3-bucket-bootstrap"
  existing_backup_files_bootstrap_bucket_name = "palworld-existing-s3-bucket-bootstrap"

• If start from backup = true then dedicated_server_name_hash is required

AWS Systems Manager Session Manager is a web based way to connect to an instance from your browser instead of over SSH. It is more secure than enabling port 22 and SSH. Use the input enable_session_manaer = true to enable it.

Palworld will update the next time the service is restarted with systemctl start palworld or systemctl restart palworld or if the server restarts.

• Monitoring the installation - You can view the user_data script that ran by connecting to your server via SSH using the public key you provided, ubuntu user, and the IP address of the server. Example: ssh -i .\palworld_public_key [email protected]. Once on the server you can view the progress of the user_data script that installs and configures palworld using the command journalctl -xu cloud-final. Use the space bar to scroll through the output line by line or shift+g to scroll the end of the output. If there is an obvvious reason that palworld failed to install or start in the way you expect, you can most likely find it here.

• Checking the palworld service is running - You can run systemctl status palworld to view the status of the palworld server. The service should say Active: active (running). If it does not, then the palworld server failed to start or has stopped for some reason.

• Using a Custom PalWorldSetting.ini From S3
• Using a Custom PalWorldSettings.ini From GitHub
• Enabling backups to S3
• Using Default Palworld Settings
• Restoring From Backup Files
• Enabling SSM and Disabling SSH

Memory leak? https://www.reddit.com/r/Palworld/comments/19bdsrn/dedicated_server_ram_usage/

No providers.

No resources.

[
  "0.0.0.0/0"
]