Elements in Five Minutes or Less

For development work, it's easy to set up a local instance of Elements. Elements runs in Docker. Using the pre-defined docker-compose.yaml, it is possible to run a fully operational instance that closely resembles the cloud deployment. With this, you can easily develop without the need to deploy or interfere with a live instance or other developers on your team.


Unless otherwise specified, earlier versions of supporting software are extremely likely to work. However, the versions listed in this section have the most extensive test coverage.

  1. Docker Version 19.03.8 or Later
  2. Docker Compose Version 1.25.0 or Later
  3. Git 2.25.1 or greater for using Cloud Functions (explained later)

Running Locally

Docker manages the installation and setup of further prerequisites including MongoDB, Redis, and the variety of microservices supporting the system. After installation of Docker, it is not necessary to install any other third-party software to begin using Elements.

The steps to run Elements are as follows:

  1. Unpack the Contents of Distribution.zip (TODO: Update URL)
  2. Execute Docker Login: docker login docker.namazustudios.net
  3. Supply credentials attached to your ECI Licensed Account. If you do not have an ECI Licensed account, go to the registration page. (TODO: add URL to get account)
  4. Navigate to the directory where you previously unpacked the distribution zip.
  5. Start the cluster using docker-compose up
  6. Navigate to your local instance in your browser: http://localhost:8080/admin
  7. The default admin username/password is root/root

Congratulations! You are ready to use Elements! The rest of this guide details Elements' functionality and the various features you may control from within the Elements control panel.

Unity Plug-In

TODO - Need to Describe Unity Plugin Here

Accessing Documentation

TODO - Need to Finish up Docserve