gistfile1.txt

# ABOUT

This is a Dockerized installation of Symbolics OpenGenera.

# WARNING!

At the moment, this ONLY runs on Linux hosts, and does not support
Docker or Docker-Machine running on OS X. I'm still working on getting
that to work.

# PREREQUISITES

In order to run this image, you MUST be running a relatively recent
version of Docker on a 64-bit Linux host.

Additionally, the Linux host MUST have NFS support installed. It is
not actually used for NFS mounting, but if NFS support is not
installed on the host, the kernel that Docker uses will not have NFS
support either, and NFS support is critical to getting Open Genera
running.

If you get a message about NFS not being supported in the kernel, make
sure you install `nfs-kernel-server` on your host.

# BUILDING

    docker build -t docker-vlm .

# RUNNING

To run the VLM under Docker, please use the included `dvlm` utility.

For a summary of help, type `dvlm -h`.

In short, dvlm is a wrapper around docker that knows how to build and
run new containers with the appropriate settings. It hides some of
Docker's more ugly complexities.

`dvlm` has two commands:

  - build: Build a new container

  - run: Run a built container

Note that `dvlm` uses a hack to get X11 working. It maps the X11 UNIX
domain socket directory into the Docker machine, allowing it to be
shared by both your main display and by genera. If you do not have the
X11 socket directory `/tmp/.X11-unix`, this hack will not work, and
`dvlm` will refuse to run.

There are three options options available when building a new
container:

- `-g`, which can point the VLM at a compiled `genera` binary on
  the local host.

- `-s`, which can point the VLM at a directory containing `sys.sct`
  on the local host.
  
- `-w`, which can point the VLM at a local vload world file to load.

# NOTES ABOUT THE INSTALL

- The Docker image includes a Genera 8.5 world with a pre-defined Site
  named "Docker".

- There is only one UNIX user, named `genera`. You may log into Genera
  with the password `xyzzy`. This password is hard-coded. If you want
  to change it, edit the definition of
  `RPC::USERNAME-AND-PASSWORD-VALID-P` in `nfs/authentication.lisp`

- The docker VLM virtual machine is named GENERA and has IP address
  192.168.2.2.

- The docker host is named GENERA-VLM and has IP address 192.168.2.1.

- NFS shares the entire UNIX root file system, as is normal with Open
  Genera.