Skip to content

Commit

Permalink
Add Maintenance Status Warnings (#125)
Browse files Browse the repository at this point in the history
The upstream project, Minecraft-Overviewer, is no longer being maintained (See overviewer/Minecraft-Overviewer@13c1bdd). This adds a maintenance status warnings to both the README.md and to the container at boot-time.
  • Loading branch information
mide authored Apr 30, 2023
1 parent 3e7458c commit 204aaeb
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ Docker Image to Run [Minecraft Overviewer](https://overviewer.org/). Overviewer

This project's code is hosted on [GitHub](https://github.com/mide/minecraft-overviewer), and the resulting Docker image is hosted on [Docker Hub](https://hub.docker.com/r/mide/minecraft-overviewer). Feel free to open [an issue on GitHub](https://github.com/mide/minecraft-overviewer/issues?q=is%3Aopen) if you're having problems.

## :construction: Maintenance Status

As of [April 5, 2023](https://github.com/overviewer/Minecraft-Overviewer/commit/13c1bddaf65dfaaf6c4c7a396c94db75bed4c089), the upstream Minecraft-Overviewer project is no longer being maintained. For more information on the matter, please check the project's [Official GitHub](https://github.com/overviewer/Minecraft-Overviewer).

## Running Minecraft Overviewer

In the below example, `minecraft-overviewer` will read input in from `/home/user/path_to_minecraft_files/` and write the output to `/home/user/path_to_write_overviewer_output/`. It will run once and exit.
Expand Down
10 changes: 10 additions & 0 deletions entrypoint.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
#!/bin/bash
set -o errexit

# https://github.com/overviewer/Minecraft-Overviewer/commit/13c1bddaf65dfaaf6c4c7a396c94db75bed4c089
echo "---------------------------------------------------------------------------"
echo " WARNING! "
echo "---------------------------------------------------------------------------"
echo "The upstream Minecraft-Overviewer project is no longer being maintained. "
echo "As this project relies entirely on Minecraf-Overviewer, some known issues "
echo "may remain open. Check out the project's official page for more details: "
echo "https://github.com/overviewer/Minecraft-Overviewer "
echo "---------------------------------------------------------------------------"

# Require MINECRAFT_VERSION environment variable to be set (no default assumed)
if [ -z "$MINECRAFT_VERSION" ]; then
echo "Expecting environment variable MINECRAFT_VERSION to be set to non-empty string. Exiting."
Expand Down

0 comments on commit 204aaeb

Please sign in to comment.