Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gdegiorgio committed Mar 7, 2024
1 parent f3ebedc commit 69b2387
Showing 1 changed file with 54 additions and 2 deletions.
56 changes: 54 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,57 @@
# Sons Of The Docker

## This project aims to provide the easiest way to setup your own [Sons Of The Forest]() dedicated host!
>⚠️ **Warning: Still Under Development** ⚠️
# Sons of the Forest - Dedicated Server with Docker :skull:

Welcome to the world of Sons of the Docker! :ghost:

Prepare yourself for a chilling journey into the depths of containerization and beyond! :zombie:

## :fire: How to Run Sons of the Docker Server on Your PC

Follow these spine-chilling steps to summon the Sons of the Docker Server to your local machine:

### :computer: Prerequisites

Ensure you have the following ghastly tools installed on your machine:

- [Docker](https://www.docker.com/) - The gateway to the underworld of containers

### :zap: Pull the Image from Docker Hub

Open your terminal and unleash the dark magic with this command:

```bash
docker pull sons-of-the-docker/server:latest
```
:skull: Run the Server

Once the image is summoned, bring it to life with the following incantation:

```bash
docker run -d --name sons_of_the_docker_server -p 8080:8080 sons-of-the-docker/server:latest
```

### :eyes: Verify the Server is Running

Peek into the netherworld to ensure the server has risen from the depths:


``` bash
docker ps
```

You should see sons_of_the_docker_server among the undead containers.
:sparkles: Access the Server

Access now to Sons Of the Forest, you will see your Sons Of The Docker instance in the LAN server list!

### :warning: Disclaimer

Beware, brave soul, for delving into the dark arts of containerization may awaken ancient evils beyond your comprehension. Proceed with caution!

### :skull_and_crossbones: Contributing

If you dare to enhance the terror of Sons of the Docker Server, feel free to summon your darkest powers and contribute to this repository. We welcome your cursed pull requests and unholy issues.

Happy haunting! :smiling_imp:

0 comments on commit 69b2387

Please sign in to comment.