/factorio-server-aws

CDK setup for factorio server hosting on AWS.

Primary LanguageTypeScriptMIT LicenseMIT

Factorio Server AWS

Automated Factorio Dedicated Server management on AWS

Intro

This project uses AWS CDK to provision everything you need to host a Factorio 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
  • Integration with duckdns.org.

This project has been adapted from Satisfactory Server AWS. Many thanks for their hard work.

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

Costs depend on the instance size you're running but if you play on the server 2 hours per day, this setup may cost less than $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

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

  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.

This project integrates with DuckDNS to point the servers address to a DNS entry. You will need to obtain a token and subdomain from othis site and add it to the config.

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