Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/agadzik/palworld-server-cdk
https://github.com/agadzik/palworld-server-cdk
Last synced: 13 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/agadzik/palworld-server-cdk
- Owner: agadzik
- Created: 2024-01-31T13:22:17.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-01-31T13:45:39.000Z (9 months ago)
- Last Synced: 2024-10-11T18:43:47.988Z (27 days ago)
- Language: TypeScript
- Size: 53.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# palworld-server-cdk
## Description
Use AWS CDK to provision the infrastructure for a dedicated Palworld server using EFS with ECS and Fargate. Also includes a simple HTTP API using API Gateway and Lambda to add Discord interactions to any Discord server you manage.
## Installation
To get started, install the AWS CDK.
```bash
pnpm install -g aws-cdk
# or
npm install -g aws-cdk
# or
yarn global add aws-cdk
```
Then, install the dependencies.
```bash
pnpm install
# or
npm install
# or
yarn
```
Next, you need to configure your AWS credentials by following the instructions [here](https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html#getting_started_auth).
Finally, you need to bootstrap your AWS environment.
```bash
cdk bootstrap --profile
```
### Discord Setup
If you want to support Discord interactions, you need to create a Discord application and bot. Follow the instructions [here](https://discord.com/developers/docs/getting-started) to create a new application and bot.
It's important to give your bot permissions to `appplications.commands` and `bot`.
Once your application bot has been created and added to your Discord server, store the `public key` value as an environment variable named `APPLICATION_PUBLIC_KEY`.
## Usage
In order to deploy the infrastructure, you need to run the following command.
```bash
APPLICATION_PUBLIC_KEY= AWS_ACCOUNT= cdk deploy --profile
```
For the first install, select `y` to approve the creation of the CloudFormation stack.
## Contributing
All PRs are welcome!
## License
This project is licensed under the MIT License.
## Kudos
[briancaffey](https://github.com/briancaffey) for his work on [valheim-cdk-discord-interactions](https://github.com/briancaffey/valheim-cdk-discord-interactions) project. This project is heavily inspired by his work.
[thijsvanloef](https://github.com/thijsvanloef) for his work on [palworld-server-docker](https://github.com/thijsvanloef/palworld-server-docker) project. This project directly uses his Docker image for the Palworld server.