wiredwizard/lambdamoo repository overview

⁠Basic Usage

You must map port 8888 and also map a shared volume for the database directory. The directory for mapping is /home/moo and this is where the moo database and log files will live.

Note: You will need to map to whatever you set as the PORT environmental variable rather than the default 8888. Also, the "---network host" option only works on Linux at the moment, so if you run this container on a Windows or Mac system, you will probably have to use a bridged network and proper connection details may be obscured from moo functions like connection_name and connection_info. This issue might be related to WSL, so other methods may give you normal results.

As a result of this limitation, I recommend running this container on a Linux docker host, using the host network and changing the PORT variable and mapping the database directory.

For Linux

docker run -dt -v ~/myMooDir:/home/moo -e TZ=America/New_York -e PORT=8888 --network host -p 8888:8888 wiredwizard/lambdamoo:1.8.3

For Mac

docker run -dt -v ~/myMooDir:/home/moo -e TZ=America/New_York -e PORT=8888 -p 8888:8888 wiredwizard/lambdamoo:1.8.3

For Windows

docker run -dt -v d:\myMooDir:/home/moo -e TZ=America/New_York -e PORT=8888 -p 8888:8888 wiredwizard/lambdamoo:1.8.3

When the container starts, it copies the packaged database into the database directory if a database is not already present. It will also create the executables and files directories if they are missing. If you wish to run a different database, simply copy the database you wish to use into the shared volume with the name "moo.db". The default tag will copy a lambdamoo database core. The other tags use a variety of different databases including a Lambdamoo2018, JH and minimal core.

⁠NOTE:

If you are running this on Linux, I HIGHLY recommend that you create a custom user on your system to run the moo, via the PUID and PGID variables. Just be certain the user has read/write access to your mapped home volume where the moo database lives. Running under root is just unnecessary and not advised.

⁠Emergency Mode

If you find yourself in the unfortunate situation of needing to run the moo in emergency virtual wizard mode, then I feel your pain. Hopefully you do not. However, if you do, you will want to launch your image using the -it flags to the run command. Below is an example on windows, but it applies to all docker hosts.

docker run -it -rm -v d:\myMooDir:/home/moo -e TZ=America/New_York -e EMERGENCY_MODE="true" -p 8888:8888 wiredwizard/lambdamoo:1.8.3

This will create a container with an interactive terminal that will load the moo in emergency mode. From this point it will be just like running emergency mode normally.

⁠Using Compose

below is a sample compose file if you wish to use compose to generate your container

version: "3.9"
services:
  lambdamoo:
    container_name: lambdamoo
    image: wiredwizard/lambdamoo:1.8.3
    tty: true
    environment:
      - TZ=UTC
    ports:
      - 8888:8888
    volumes:
      - /your_moo_dir:/home/moo

⁠Environmental Variables

There are a number of environmental variables you may define to change server behavior. The following are all variable options
TZ = This will determine the local time zone of the server.
PORT = This determines the listening port of the server for normal connections.
PUID = The id of the host system user you would like your container to run under. (You must specify both PUID and PGID to use either variable)
PGID = The id of the host system group you would like your container to run under. (You must specify both PUID and PGID to use either variable)
EMERGENCY_MODE = If this variable is defined with a value of true, the server will start in emergency virtual wizard mode. For this to operate properly, you should pass the -it flags to your docker run command when you run the image.
INCLUDED_CORE = This is informational and used by scripts. DO NOT delete or change this variable.