diff --git a/MagicBox-%3A-Magicbane-in-a-Box.md b/MagicBox-%3A-Magicbane-in-a-Box.md index eedda0a..3ee2543 100644 --- a/MagicBox-%3A-Magicbane-in-a-Box.md +++ b/MagicBox-%3A-Magicbane-in-a-Box.md @@ -32,11 +32,11 @@ Pull the image ```console docker pull magicbane/magicbox ``` -Start your MagicBox +### Starting MagicBox ```console docker run --name magicbox -p 5000:5000 -p 6000:6000 -p 8000:8000 -v /home/mbbox/mb.conf:/home/mbbox/magicbane/mb.conf magicbane/magicbox:latest & ``` ->It is recommended that you change the external port via the docker run command not within the [magicbane.conf](http://repo.magicbane.com/MagicBane/Server/wiki/magicbane.conf) configuration file. Docker will automatically route ip traffic through the bridge to the corect interal port. MagicBox uses three ports. 5000 is used for a debugger or profiler. 6000 is used for the login server. 8000 is used for the world server. If behind a NAT/router the user must open these ports on his router or configure a DMZ. +>It is recommended that you change the external port via the docker run command not within the [magicbane.conf](http://repo.magicbane.com/MagicBane/Server/wiki/magicbane.conf) configuration file. Docker will automatically route ip traffic through the bridge to the correct interal port. MagicBox uses three ports. 5000 is used for a debugger or profiler. 6000 is used for the login server. 8000 is used for the world server. If behind a NAT/router the user must open these ports on his router or configure a DMZ. Below is the script the MagicBane team uses to cycle MagicBox in testing. @@ -57,6 +57,10 @@ echo "Starting MagicBox" docker run --name magicbox -p 5000:5000 -p 6000:6000 -p 8000:8000 -v /home/mbbox/mb.conf:/home/mbbox/magicbane/mb.conf magicbane/magicbox:latest & ``` +Upon starting MagicBox will look for a [magicbane.conf](http://repo.magicbane.com/MagicBane/Server/wiki/magicbane.conf) within the mb.conf directory tmounted via the run command. If it cannot be found the game will instead use a local copy inside mb.data to boot the game. + +This facility allows a MagicBox administrator to point his game at an external database at runtime. + When a MagicBox administrator first spins up his server it is assumed they might not have web registration sorted on day one. With this in mind the server is configured to auto register accounts on login. ```MB_LOGIN_AUTOREG="TRUE"``` @@ -64,4 +68,10 @@ When a MagicBox administrator first spins up his server it is assumed they might When the time comes whether through Discord or Forum registration we have the backend facilities to plug right into. ```CALL singleAccountCreate(?,?);``` -```CALL discordAccountCreate(?,?,?);``` \ No newline at end of file +```CALL discordAccountCreate(?,?,?);``` + +### Logging into the MagicBox + +Once MagicBox is running the following will grant you shell access. + +```console docker exec -it magicbox /bin/bash``` \ No newline at end of file