VRSpace.org

Guide to pull/build/run a Debian based image of VRSpace from github¶

Requirements:

• Docker Desktop for Windows - https://www.docker.com/products/docker-desktop
• Basic knowledge of Powershell
• Basic knowledge of Docker

This guide assumes you already have Docker Desktop setup and running.
If not please refer to this guide: https://docs.docker.com/desktop/windows/install/

Lets get started¶

Download the dockerfile attached to this post or create one with the following code:

# syntax=docker/dockerfile:1
FROM debian:latest

#Install git, bash, java, maven
RUN apt update && apt install -y \
    git \
    bash-completion \
    default-jdk\
    maven

#Set working directory
WORKDIR /home/

#Clone VRSpace from github       
RUN git clone https://github.com/jalmasi/vrspace.git

#Expose ports 8080 and 8443
EXPOSE 8080
EXPOSE 8443

This will tell Docker to pull the latest Debian image, install "git, bash, java, and maven"
then clone the VRSpace github repo into the /home/vrspace/ directory, and expose ports 8080 and 8443.

Next open Powershell and navigate to the directory with the dockerfile
run the command

 docker build -t vrspace . 

This will create an image called vrspace from the dockerfile
It may take a while to download everything and you should end up with an image that's about 3GB

Run the image as a container¶

Open the Docker Desktop GUI and navigate to Images on the lefthand menu.
Hover over the vrspace image we created and click the blue run button that appears on the right.

Click the optional settings and then plus button on the righthand side of Container Port.
Fill in the Local Host ports to match the container port (unless you need it to be something else)
Add a name then click Run

Compile VRSpace inside the container¶

Inside the Docker Desktop GUI navigate to Container/Apps on the lefthand side
You should see your started container

Hover over the container and click the CLI button on the righthand side that appears
In the command prompt that pops up type:

cd vrspace

then

mvn clean install -DskipTests

This will download the requirements for maven then compile VRSpace

Run the webserver and log into VRSpace on the local machine¶

Navigate to the server directory with

cd server

then run the server with:

java -jar target/server-0.4.5-SNAPSHOT.jar

Congrats you now have a local instance of VRSpace running inside a Docker Container!

Navigate to the server¶

Open a web browser and go to:

http://localhost:8080/babylon/

This will take you to a directory view of test pages you can run

If you want to jump into the portal page go to:

http://localhost:8080/babylon/avatar-selection.html