mirror of
https://gitlab.com/crafty-controller/crafty-4.git
synced 2024-08-30 18:23:09 +00:00
Remove Commander naming and bump README.md
Also fix unraid.xml links
This commit is contained in:
Zedifus
parent
d2102bbca0
commit
7d1111ea56
10
Dockerfile
10
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
|
||||
|
||||
56
README.md
56
README.md
@ -2,11 +2,11 @@
|
||||
|
||||
[](https://github.com/psf/black)
|
||||
[](https://www.python.org)
|
||||
[](https://gitlab.com/crafty-controller/crafty-commander)
|
||||
[](https://gitlab.com/crafty-controller/crafty-commander)
|
||||
[](https://gitlab.com/crafty-controller/crafty-commander/-/commits/master)
|
||||
[](https://gitlab.com/crafty-controller/crafty-4)
|
||||
[](https://gitlab.com/crafty-controller/crafty-4)
|
||||
[](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]🔻**__ <br>
|
||||
BE ADVISED! Upstream is currently broken for Minecraft running on **Docker under WSL/WSL2, Windows 11 / DOCKER DESKTOP!** <br>
|
||||
On '**Stop**' or '**Restart**' of the MC Server, there is a 90% chance the World's Chunks will be shredded irreparably! <br>
|
||||
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 | [](https://gitlab.com/crafty-controller/crafty-commander/-/commits/master) |
|
||||
| :dev | [](https://gitlab.com/crafty-controller/crafty-commander/-/commits/dev) |
|
||||
| :latest | [](https://gitlab.com/crafty-controller/crafty-4/-/commits/master) |
|
||||
| :dev | [](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.
|
||||
|
||||
@ -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
|
||||
|
||||
@ -3,7 +3,7 @@ version: '3'
|
||||
|
||||
services:
|
||||
crafty:
|
||||
container_name: crafty_commander
|
||||
container_name: crafty_container
|
||||
build: ..
|
||||
environment:
|
||||
- TZ=Etc/UTC
|
||||
@ -14,8 +14,8 @@ services:
|
||||
- "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
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
<?xml version="1.0"?>
|
||||
<Container version="2">
|
||||
<Name>Crafty</Name>
|
||||
<Repository>crafty-controller/crafty-commander:latest</Repository>
|
||||
<Registry>registry.gitlab.com/crafty-controller/crafty-commander</Registry>
|
||||
<Repository>crafty-controller/crafty-4:latest</Repository>
|
||||
<Registry>registry.gitlab.com/crafty-controller/crafty-4</Registry>
|
||||
<Network>bridge</Network>
|
||||
<MyIP/>
|
||||
<Shell>sh</Shell>
|
||||
@ -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/
|
||||
</Overview>
|
||||
<Category>GameServers: Other:</Category>
|
||||
<WebUI>https://[IP]:[PORT:8443]/</WebUI>
|
||||
<TemplateURL>https://gitlab.com/crafty-controller/crafty-commander/-/blob/dev/docker/unraid.xml</TemplateURL>
|
||||
<Icon>https://gitlab.com/crafty-controller/crafty-commander/-/raw/master/app/frontend/static/assets/images/logo_square.jpg</Icon>
|
||||
<TemplateURL>https://gitlab.com/crafty-controller/crafty-4/-/blob/dev/docker/unraid.xml</TemplateURL>
|
||||
<Icon>https://gitlab.com/crafty-controller/crafty-4/-/raw/master/app/frontend/static/assets/images/logo_square.jpg</Icon>
|
||||
<ExtraParams/>
|
||||
<PostArgs/>
|
||||
<CPUset/>
|
||||
@ -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
|
||||
</Description>
|
||||
<Networking>
|
||||
<Mode>bridge</Mode>
|
||||
@ -64,27 +64,27 @@ For migration from 3.x please refer to the documentation on GitLab: https://gitl
|
||||
<Data>
|
||||
<Volume>
|
||||
<HostDir>/mnt/user/appdata/Crafty-4/servers/</HostDir>
|
||||
<ContainerDir>/commander/servers</ContainerDir>
|
||||
<ContainerDir>/crafty/servers</ContainerDir>
|
||||
<Mode>rw</Mode>
|
||||
</Volume>
|
||||
<Volume>
|
||||
<HostDir>/mnt/user/appdata/Crafty-4/backups/</HostDir>
|
||||
<ContainerDir>/commander/backups</ContainerDir>
|
||||
<ContainerDir>/crafty/backups</ContainerDir>
|
||||
<Mode>rw</Mode>
|
||||
</Volume>
|
||||
<Volume>
|
||||
<HostDir>/mnt/user/appdata/Crafty-4/logs/</HostDir>
|
||||
<ContainerDir>/commander/logs</ContainerDir>
|
||||
<ContainerDir>/crafty/logs</ContainerDir>
|
||||
<Mode>rw</Mode>
|
||||
</Volume>
|
||||
<Volume>
|
||||
<HostDir>/mnt/user/appdata/Crafty-4/config/</HostDir>
|
||||
<ContainerDir>/commander/app/config</ContainerDir>
|
||||
<ContainerDir>/crafty/app/config</ContainerDir>
|
||||
<Mode>rw</Mode>
|
||||
</Volume>
|
||||
<Volume>
|
||||
<HostDir>/mnt/user/appdata/Crafty-4/import/</HostDir>
|
||||
<ContainerDir>/commander/import</ContainerDir>
|
||||
<ContainerDir>/crafty/import</ContainerDir>
|
||||
<Mode>rw</Mode>
|
||||
</Volume>
|
||||
</Data>
|
||||
@ -95,9 +95,9 @@ For migration from 3.x please refer to the documentation on GitLab: https://gitl
|
||||
<Config Name="Minecraft ports" Target="25500-25600" Default="25500-25600" Mode="tcp" Description="Container Port: 25500-25600 yes, 100 ports for 100 possible Servers" Type="Port" Display="always-hide" Required="true" Mask="false">25500-25600</Config>
|
||||
<Config Name="Port for dynmap" Target="8123" Default="8123" Mode="tcp" Description="Dynmap port" Type="Port" Display="always-hide" Required="true" Mask="false">8123</Config>
|
||||
<Config Name="Port for bedrock server" Target="19132" Default="19132" Mode="udp" Description="Bedrock server port" Type="Port" Display="always-hide" Required="true" Mask="false">19132</Config>
|
||||
<Config Name="Server files" Target="/commander/servers" Default="/mnt/user/appdata/Crafty-4/servers/" Mode="rw" Description="Path to the minecraft server folders" Type="Path" Display="always-hide" Required="true" Mask="false">/mnt/user/appdata/Crafty-4/servers/</Config>
|
||||
<Config Name="Backup files" Target="/commander/backups" Default="/mnt/user/appdata/Crafty-4/backups/" Mode="rw" Description="Server Backups" Type="Path" Display="always-hide" Required="true" Mask="false">/mnt/user/appdata/Crafty-4/backups/</Config>
|
||||
<Config Name="Server Logs" Target="/commander/logs" Default="/mnt/user/appdata/Crafty-4/logs/" Mode="rw" Description="Logs" Type="Path" Display="advanced-hide" Required="true" Mask="false">/mnt/user/appdata/Crafty-4/logs/</Config>
|
||||
<Config Name="Crafty Configuration" Target="/commander/app/config" Default="/mnt/user/appdata/Crafty-4/config/" Mode="rw" Description="Path to the persistent Crafty files" Type="Path" Display="advanced-hide" Required="true" Mask="false">/mnt/user/appdata/Crafty-4/config/</Config>
|
||||
<Config Name="Import folder" Target="/commander/import" Default="/mnt/user/appdata/Crafty-4/import/" Mode="rw" Description="Imports" Type="Path" Display="advanced-hide" Required="true" Mask="false">/mnt/user/appdata/Crafty-4/import/</Config>
|
||||
<Config Name="Server files" Target="/crafty/servers" Default="/mnt/user/appdata/Crafty-4/servers/" Mode="rw" Description="Path to the minecraft server folders" Type="Path" Display="always-hide" Required="true" Mask="false">/mnt/user/appdata/Crafty-4/servers/</Config>
|
||||
<Config Name="Backup files" Target="/crafty/backups" Default="/mnt/user/appdata/Crafty-4/backups/" Mode="rw" Description="Server Backups" Type="Path" Display="always-hide" Required="true" Mask="false">/mnt/user/appdata/Crafty-4/backups/</Config>
|
||||
<Config Name="Server Logs" Target="/crafty/logs" Default="/mnt/user/appdata/Crafty-4/logs/" Mode="rw" Description="Logs" Type="Path" Display="advanced-hide" Required="true" Mask="false">/mnt/user/appdata/Crafty-4/logs/</Config>
|
||||
<Config Name="Crafty Configuration" Target="/crafty/app/config" Default="/mnt/user/appdata/Crafty-4/config/" Mode="rw" Description="Path to the persistent Crafty files" Type="Path" Display="advanced-hide" Required="true" Mask="false">/mnt/user/appdata/Crafty-4/config/</Config>
|
||||
<Config Name="Import folder" Target="/crafty/import" Default="/mnt/user/appdata/Crafty-4/import/" Mode="rw" Description="Imports" Type="Path" Display="advanced-hide" Required="true" Mask="false">/mnt/user/appdata/Crafty-4/import/</Config>
|
||||
</Container>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user