Satisfactory Server AWS

Automated Satisfactory Dedicated Server management on AWS

zjt's fork

This fork of satisfactory-server-aws includes the following enhancements

1. Architecture diagram
   • blue is implemented
   • green is planned
   • yellow is from upstream
2. Implemented
   • EventBridge event on EC2 state changes result in SSM Parameters to store running instance IP and stop time
   • Larger instance size. Note: this increases the cost estimate as stated below.
   • Update Route 53 zone with running instance IP
   • Discord integration
3. Planned
   • Monitoring and size/cost optimization
   • Incorporate capabilities of https://hub.docker.com/r/vinanrra/satisfactory-server

Configure

server-hosting/config.ts

Set these options:

• Route53Zone - zone will be created if it doesn't exist. If it exists as a subdomain of another zone then point the NS records at it
• Route53Name - record within the zone that will be associated with the satisfactory server
• startApiName - record withing the zone that will be associate with the startServer URL
• DiscordWebHook - webhook URL for your discord channel
• ServerInstanceType - type of EC2 instance for the satisfactory server
• serverUpMessage - message you want displayed in discord when the server starts
• serverDownMessage - message you want displayed in discord when the server stops
• tagKey - tag key for all resources created
• tagVal - tag value for all resource created

Intro

FICSIT Incorporated has provided you with this tool (cost deducted from your existing balance) to assist you with Project Assembly. This tool can help you collaborate with friends on your factory projects.

This project uses AWS CDK to provision everything you need to host a Satisfactory Dedicated Server on AWS. It includes the following:

• VPC/Network configuration
• Ec2 Instance provisioning
• Automatic shutdown behavior when not in use (saves $$)
• Automatic game file backup to s3
• A Lambda browser endpoint to start the server back up

Why use AWS when you can host for free on your own computer?

• If you want to allow friends to play on your server without you, you will have to always leave your computer on and the server running continuously, even if you are not playing. Having it on the cloud frees up your hardware.
• Your computer may not have enough resources to host the server and play at the same time.

Costs

If you play on the server 2 hours per day, this setup will cost around $5/month on AWS.

Since the server automatically shuts down when not in use, you only pay when the server is up and you (or your friends) are actively playing on it.

S3 and Lambda usage costs are free tier eligible.

Disclaimers

This is a free and open source project and there are no guarantees that it will work or always continue working. If you use it, you are responsible for maintaining your setup and monitoring and paying for your AWS bill. It is a great project for learning a little AWS and CDK, but it is not so great if you wish to have a hands-off experience managing your game server.

Requirements

• AWS Account
• Git
• AWS Command Line Interface (cli)
• NodeJs

Configuration

Copy the given server-hosting/config.sample.ts file to server-hosting/config.ts file. Fill the fields with appropriate values. Explanation for each field is given in file itself.

At a minimum, account (account number) and region are required.

Quick Start

This assumes you have all requirements and have configured aws cli

The Step Functions CDK integration depends on the following npm i @matthewbonig/state-machine

1. Clone this project
2. npm install
3. npx cdk bootstrap <aws account number>/<aws region> (replace account number and region)
4. cp server-hosting/.config.sample.ts server-hosting/.config.ts if you have not done so (see Configuration for customization); you must fill in region and account
5. npx cdk deploy
6. Wait for the CloudFormation stack to finish. It may take a few minutes for the server to download/install everything after the stack is finished.
7. Use the Ec2 instance public IP address to connect to your server in Satisfactory Server Manager (see DNS and IP management)
8. Start a new game or upload a save

Accessing your server

Access to the EC2 instance hosting your Satisfactory server can be done via Session Manager. External SSH is blocked by default at the network level. Tip: ssm may open /bin/sh, running bash can get you to a more familiar bash shell.

DNS and IP management

When your ec2 instance shuts down and starts back up, there's no gurantee that the IP address will stay the same. If it changes, you will have to re-add the server in Server Manager. There are a couple ways to fix the issue:

1. Elastic IP - Create and assign it to your ec2 instance in AWS. Your Elatic IP will never change, but you will get charged for it when it is not in use ($0.001/hour or $3.60/month if never used). This method also allows you to use your own custom domain address if wish.
2. Dynamic DNS - Free dynamic DNS services like DuckDns provide a way to automatically manage when the IP address changes. Once setup, you just use their url and they handle everything else behind the scenes. This method may not allow you to use a custom domain.

Starting the server back up

After deploying, there will be a Lambda setup with Api Gateway. This provides a url that you (or your friends) can hit in any browser to start the server back up when you want to play. To find this URL, navigate in AWS to API Gateway -> SatisfactoryHostingStartServerApi -> Dashboard (lefthand menu); the url is at the top next to "Invoke this API at:"

Contributing