From 2d218d92997b71bb4baabdfe20fc9519b50ef225 Mon Sep 17 00:00:00 2001
From: Roger <rwm810@gmail.com>
Date: Sun, 24 Nov 2024 14:32:53 -0500
Subject: [PATCH] added

---
 .dockerignorefile |  2 ++
 .gitignore        | 17 +------------
 README.md         | 64 ++++++++++++++++++++++++++++++++++++++++++++++-
 3 files changed, 66 insertions(+), 17 deletions(-)
 create mode 100644 .dockerignorefile

diff --git a/.dockerignorefile b/.dockerignorefile
new file mode 100644
index 0000000..717b807
--- /dev/null
+++ b/.dockerignorefile
@@ -0,0 +1,2 @@
+README.md
+.git
\ No newline at end of file
diff --git a/.gitignore b/.gitignore
index 4cb12d8..b8c440d 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,16 +1 @@
-# Node rules:
-## Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-## Dependency directory
-## Commenting this out is preferred by some people, see
-## https://docs.npmjs.com/misc/faq#should-i-check-my-node_modules-folder-into-git
-node_modules
-
-# Book build output
-_book
-
-# eBook build output
-*.epub
-*.mobi
-*.pdf
+description
\ No newline at end of file
diff --git a/README.md b/README.md
index 8ad989a..75991cf 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,63 @@
-# docker-allthemods10
\ No newline at end of file
+# [All the Mods 10-1.23.0](https://www.curseforge.com/minecraft/modpacks/all-the-mods-10) on Curseforge
+<!-- toc -->
+
+- [Description](#description)
+- [Requirements](#requirements)
+- [Options](#options)
+  * [Adding Minecraft Operators](#adding-minecraft-operators)
+- [Troubleshooting](#troubleshooting)
+  * [Accept the EULA](#accept-the-eula)
+  * [Permissions of Files](#permissions-of-files)
+  * [Resetting](#resetting)
+- [Source](#source)
+
+<!-- tocstop -->
+
+## Description
+
+This container is built to run on an [Unraid](https://unraid.net) server, outside of that your milliage will vary.
+
+The docker on first run will download the same version as tagged of `All the Mods 10-1.23.0` and install it.  This can take a while as the Forge installer can take a bit to complete.  You can watch the logs and it will eventually finish.
+
+After the first run it will simply start the server.
+
+Note: There are no modded minecraft files shipped in the container, they are all downloaded at runtime.
+
+## Requirements
+
+* /data mounted to a persistent disk
+* Port 25565/tcp mapped
+* environment variable EULA set to "true"
+
+As the end user, you are repsonsible for accepting the EULA from Mojang to run their server, by default in the container it is set to false.
+
+## Options
+
+These environment variables can be set at run time to override their defaults.
+
+* JVM_OPTS "-Xms2048m -Xmx4096m"
+* MOTD "All the Mods 10-1.23.0 Server Powered by Docker"
+* LEVEL world
+
+### Adding Minecraft Operators
+
+Set the enviroment variable `OPS` with a comma separated list of players.
+
+example:
+`OPS="OpPlayer1,OpPlayer2"`
+
+## Troubleshooting
+
+### Accept the EULA
+Did you pass in the environment variable EULA set to `true`?
+
+### Permissions of Files
+This container is designed for [Unraid](https://unraid.net) so the user in the container runs on uid 99 and gid 100.  This may cause permission errors on the /data mount on other systems.
+
+### Resetting
+If the install is incomplete for some reason.  Deleting the downloaded server file in /data will restart the install/upgrade process.
+
+## Source
+Github: https://github.com/Goobaroo/docker-allthemods9
+
+Docker: https://hub.docker.com/repository/docker/goobaroo/allthemods9