diff --git a/Dockerfile b/Dockerfile index 692150cb..241e5006 100644 --- a/Dockerfile +++ b/Dockerfile @@ -7,8 +7,8 @@ ENV LOG4J_FORMAT_MSG_NO_LOOKUPS=true # Create non-root user & required dirs RUN useradd -g root -M crafty \ - && mkdir /commander \ - && chown -R crafty:root /commander + && mkdir /crafty \ + && chown -R crafty:root /crafty # Install required system packages RUN apt-get update \ @@ -30,7 +30,7 @@ RUN apt-get update \ # Switch to service user for installing crafty deps USER crafty -WORKDIR /commander +WORKDIR /crafty COPY --chown=crafty:root requirements.txt ./ RUN python3 -m venv ./.venv \ && . .venv/bin/activate \ @@ -51,8 +51,8 @@ EXPOSE 8443 EXPOSE 19132 EXPOSE 25500-25600 -# Start Crafty Commander through wrapper -ENTRYPOINT ["/commander/docker_launcher.sh"] +# Start Crafty through wrapper +ENTRYPOINT ["/crafty/docker_launcher.sh"] CMD ["-v", "-d", "-i"] # Add meta labels diff --git a/README.md b/README.md index 6d679404..759baff6 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,11 @@ [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![Supported Python Versions](https://shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20-blue)](https://www.python.org) -[![Version(temp-hardcoded)](https://img.shields.io/badge/release-v4.0.0--alpha3.5-orange)](https://gitlab.com/crafty-controller/crafty-commander) -[![Code Quality(temp-hardcoded)](https://img.shields.io/badge/code%20quality-10-brightgreen)](https://gitlab.com/crafty-controller/crafty-commander) -[![Build Status](https://gitlab.com/crafty-controller/crafty-commander/badges/master/pipeline.svg)](https://gitlab.com/crafty-controller/crafty-commander/-/commits/master) +[![Version(temp-hardcoded)](https://img.shields.io/badge/release-v4.0.0--beta-orange)](https://gitlab.com/crafty-controller/crafty-4) +[![Code Quality(temp-hardcoded)](https://img.shields.io/badge/code%20quality-10-brightgreen)](https://gitlab.com/crafty-controller/crafty-4) +[![Build Status](https://gitlab.com/crafty-controller/crafty-4/badges/master/pipeline.svg)](https://gitlab.com/crafty-controller/crafty-4/-/commits/master) -# Crafty Controller 4.0.0-alpha.3.5 +# Crafty Controller 4.0.0-beta > Python based Control Panel for your Minecraft Server ## What is Crafty Controller? @@ -39,7 +39,7 @@ With `Crafty Controller 4.0` we have focused on building our DevOps Principles, > __**⚠ 🔻WARNING: [WSL/WSL2 | WINDOWS 11 | DOCKER DESKTOP]🔻**__
BE ADVISED! Upstream is currently broken for Minecraft running on **Docker under WSL/WSL2, Windows 11 / DOCKER DESKTOP!**
On '**Stop**' or '**Restart**' of the MC Server, there is a 90% chance the World's Chunks will be shredded irreparably!
- Please only run Docker on Linux, If you are using Windows we have a portable installs found here: [Latest-Stable](https://gitlab.com/crafty-controller/crafty-commander/-/jobs/artifacts/master/download?job=win-prod-build), [Latest-Development](https://gitlab.com/crafty-controller/crafty-commander/-/jobs/artifacts/dev/download?job=win-dev-build) + Please only run Docker on Linux, If you are using Windows we have a portable installs found here: [Latest-Stable](https://gitlab.com/crafty-controller/crafty-4/-/jobs/artifacts/master/download?job=win-prod-build), [Latest-Development](https://gitlab.com/crafty-controller/crafty-4/-/jobs/artifacts/dev/download?job=win-dev-build) ---- @@ -55,11 +55,11 @@ As the Dockerfile uses the permission structure of `crafty:root` **internally** ### - Using the registry image 🌎 The provided image supports both `arm64` and `amd64` out the box, if you have issues though you can build it yourself with the `compose` file in `docker/`. -The image is located at: `registry.gitlab.com/crafty-controller/crafty-commander:latest` +The image is located at: `registry.gitlab.com/crafty-controller/crafty-4:latest` | Branch | Status | | ----------------- | ------------------------------------------------------------------ | -| :latest | [![pipeline status](https://gitlab.com/crafty-controller/crafty-commander/badges/master/pipeline.svg)](https://gitlab.com/crafty-controller/crafty-commander/-/commits/master) | -| :dev | [![pipeline status](https://gitlab.com/crafty-controller/crafty-commander/badges/dev/pipeline.svg)](https://gitlab.com/crafty-controller/crafty-commander/-/commits/dev) | +| :latest | [![pipeline status](https://gitlab.com/crafty-controller/crafty-4/badges/master/pipeline.svg)](https://gitlab.com/crafty-controller/crafty-4/-/commits/master) | +| :dev | [![pipeline status](https://gitlab.com/crafty-controller/crafty-4/badges/dev/pipeline.svg)](https://gitlab.com/crafty-controller/crafty-4/-/commits/dev) | While the repository is still **private / pre-release**, Before you can pull the image you must authenticate docker with the Container Registry. @@ -94,8 +94,8 @@ version: '3' services: crafty: - container_name: crafty_commander - image: registry.gitlab.com/crafty-controller/crafty-commander:latest + container_name: crafty_container + image: registry.gitlab.com/crafty-controller/crafty-4:latest environment: - TZ=Etc/UTC ports: @@ -105,11 +105,11 @@ services: - "19132:19132/udp" # BEDROCK - "25500-25600:25500-25600" # MC SERV PORT RANGE volumes: - - ./docker/backups:/commander/backups - - ./docker/logs:/commander/logs - - ./docker/servers:/commander/servers - - ./docker/config:/commander/app/config - - ./docker/import:/commander/import + - ./docker/backups:/crafty/backups + - ./docker/logs:/crafty/logs + - ./docker/servers:/crafty/servers + - ./docker/config:/crafty/app/config + - ./docker/import:/crafty/import ``` ```sh $ docker-compose up -d && docker-compose logs -f @@ -119,19 +119,19 @@ $ docker-compose up -d && docker-compose logs -f ### **docker run:** ```sh $ docker run \ - --name crafty_commander \ + --name crafty_container \ -p 8000:8000 \ -p 8443:8443 \ -p 8123:8123 \ -p 19132:19132/udp \ -p 25500-25600:25500-25600 \ -e TZ=Etc/UTC \ - -v "/$(pwd)/docker/backups:/commander/backups" \ - -v "/$(pwd)/docker/logs:/commander/logs" \ - -v "/$(pwd)/docker/servers:/commander/servers" \ - -v "/$(pwd)/docker/config:/commander/app/config" \ - -v "/$(pwd)/docker/import:/commander/import" \ - registry.gitlab.com/crafty-controller/crafty-commander:latest + -v "/$(pwd)/docker/backups:/crafty/backups" \ + -v "/$(pwd)/docker/logs:/crafty/logs" \ + -v "/$(pwd)/docker/servers:/crafty/servers" \ + -v "/$(pwd)/docker/config:/crafty/app/config" \ + -v "/$(pwd)/docker/import:/crafty/import" \ + registry.gitlab.com/crafty-controller/crafty-4:latest ``` ### **Building from the cloned repository:** @@ -144,18 +144,18 @@ If you'd rather not use `docker-compose` you can use the following `docker run` $ docker build . -t crafty $ docker run \ - --name crafty_commander \ + --name crafty_container \ -p 8000:8000 \ -p 8443:8443 \ -p 8123:8123 \ -p 19132:19132/udp \ -p 25500-25600:25500-25600 \ -e TZ=Etc/UTC \ - -v "/$(pwd)/docker/backups:/commander/backups" \ - -v "/$(pwd)/docker/logs:/commander/logs" \ - -v "/$(pwd)/docker/servers:/commander/servers" \ - -v "/$(pwd)/docker/config:/commander/app/config" \ - -v "/$(pwd)/docker/import:/commander/import" \ + -v "/$(pwd)/docker/backups:/crafty/backups" \ + -v "/$(pwd)/docker/logs:/crafty/logs" \ + -v "/$(pwd)/docker/servers:/crafty/servers" \ + -v "/$(pwd)/docker/config:/crafty/app/config" \ + -v "/$(pwd)/docker/import:/crafty/import" \ crafty ``` A fresh build will take several minutes depending on your system, but will be rapid thereafter. diff --git a/docker-compose.yml.example b/docker-compose.yml.example index 38bf54c3..d2850e68 100644 --- a/docker-compose.yml.example +++ b/docker-compose.yml.example @@ -3,8 +3,8 @@ version: '3' services: crafty: - container_name: crafty_commander - image: registry.gitlab.com/crafty-controller/crafty-commander:latest + container_name: crafty_container + image: registry.gitlab.com/crafty-controller/crafty-4:latest environment: - TZ=Etc/UTC ports: @@ -14,8 +14,8 @@ services: - "19132:19132/udp" # BEDROCK - "25500-25600:25500-25600" # MC SERV PORT RANGE volumes: - - ./docker/backups:/commander/backups - - ./docker/logs:/commander/logs - - ./docker/servers:/commander/servers - - ./docker/config:/commander/app/config - - ./docker/import:/commander/import + - ./docker/backups:/crafty/backups + - ./docker/logs:/crafty/logs + - ./docker/servers:/crafty/servers + - ./docker/config:/crafty/app/config + - ./docker/import:/crafty/import diff --git a/docker/docker-compose.yml b/docker/docker-compose.yml index 4342880c..59f7061e 100644 --- a/docker/docker-compose.yml +++ b/docker/docker-compose.yml @@ -3,19 +3,19 @@ version: '3' services: crafty: - container_name: crafty_commander + container_name: crafty_container build: .. environment: - TZ=Etc/UTC ports: - - "8000:8000" # HTTP - - "8443:8443" # HTTPS - - "8123:8123" # DYNMAP - - "19132:19132/udp" # BEDROCK - - "25500-25600:25500-25600" # MC SERV PORT RANGE + - "8000:8000" # HTTP + - "8443:8443" # HTTPS + - "8123:8123" # DYNMAP + - "19132:19132/udp" # BEDROCK + - "25500-25600:25500-25600" # MC SERV PORT RANGE volumes: - - ./backups:/commander/backups - - ./logs:/commander/logs - - ./servers:/commander/servers - - ./config:/commander/app/config - - ./import:/commander/import + - ./backups:/crafty/backups + - ./logs:/crafty/logs + - ./servers:/crafty/servers + - ./config:/crafty/app/config + - ./import:/crafty/import diff --git a/docker/unraid.xml b/docker/unraid.xml index b82f6e6a..a0ba70a6 100644 --- a/docker/unraid.xml +++ b/docker/unraid.xml @@ -1,8 +1,8 @@ Crafty - crafty-controller/crafty-commander:latest - registry.gitlab.com/crafty-controller/crafty-commander + crafty-controller/crafty-4:latest + registry.gitlab.com/crafty-controller/crafty-4 bridge sh @@ -13,12 +13,12 @@ The username and password appear on the first launch in the Docker logs! Crafty 4 is the successor of Crafty Controller, the Docker image is no longer maintained on DockerHub. (now on GitLab) For official support join the discord: https://discord.gg/9VJPhCE -For migration from 3.x please refer to the documentation on GitLab: https://gitlab.com/crafty-controller/crafty-commander/-/wikis/home +For migration from 3.x please refer to the documentation on GitLab: https://wiki.craftycontrol.com/ GameServers: Other: https://[IP]:[PORT:8443]/ - https://gitlab.com/crafty-controller/crafty-commander/-/blob/dev/docker/unraid.xml - https://gitlab.com/crafty-controller/crafty-commander/-/raw/master/app/frontend/static/assets/images/logo_square.jpg + https://gitlab.com/crafty-controller/crafty-4/-/blob/dev/docker/unraid.xml + https://gitlab.com/crafty-controller/crafty-4/-/raw/master/app/frontend/static/assets/images/logo_square.jpg @@ -29,7 +29,7 @@ For migration from 3.x please refer to the documentation on GitLab: https://gitl The username and password appear on the first launch in the Docker logs! Crafty 4 is the successor of Crafty Controller, the Docker image is no longer maintained on DockerHub. (now on GitLab) For official support join the discord: https://discord.gg/9VJPhCE -For migration from 3.x please refer to the documentation on GitLab: https://gitlab.com/crafty-controller/crafty-commander/-/wikis/home +For migration from 3.x please refer to the documentation on GitLab: https://gitlab.com/crafty-controller/crafty-4/-/wikis/home bridge @@ -64,27 +64,27 @@ For migration from 3.x please refer to the documentation on GitLab: https://gitl /mnt/user/appdata/Crafty-4/servers/ - /commander/servers + /crafty/servers rw /mnt/user/appdata/Crafty-4/backups/ - /commander/backups + /crafty/backups rw /mnt/user/appdata/Crafty-4/logs/ - /commander/logs + /crafty/logs rw /mnt/user/appdata/Crafty-4/config/ - /commander/app/config + /crafty/app/config rw /mnt/user/appdata/Crafty-4/import/ - /commander/import + /crafty/import rw @@ -95,9 +95,9 @@ For migration from 3.x please refer to the documentation on GitLab: https://gitl 25500-25600 8123 19132 - /mnt/user/appdata/Crafty-4/servers/ - /mnt/user/appdata/Crafty-4/backups/ - /mnt/user/appdata/Crafty-4/logs/ - /mnt/user/appdata/Crafty-4/config/ - /mnt/user/appdata/Crafty-4/import/ + /mnt/user/appdata/Crafty-4/servers/ + /mnt/user/appdata/Crafty-4/backups/ + /mnt/user/appdata/Crafty-4/logs/ + /mnt/user/appdata/Crafty-4/config/ + /mnt/user/appdata/Crafty-4/import/