Installation#

For a quick preview, follow the Quick Start guide.

Prerequisites#

Step 1: Get Scenescape#

Note that these operations must be executed when logged in as a standard (non-root) user. Do NOT use root or sudo.

  1. Download the Scenescape software archive from open-edge-platform/scenescape.

  2. Extract the Scenescape archive on the target Ubuntu system. Change directories to the extracted Scenescape folder.

    cd scenescape-<version>
    

Clone the repository and change directories to the cloned repository:

git clone https://github.com/open-edge-platform/scenescape.git -b main
cd scenescape/

Note: The default branch is main. To work with a stable release version, list the available tags and checkout a specific version tag:

git tag
git checkout <tag-version>

Step 2: Choose a Deployment#

Scenescape can run on Docker Compose or on Kubernetes, and can be deployed clean (an empty scene database, ready for your own cameras and scenes) or with the bundled demo (two sample scenes preloaded with recorded video). Either way, you first need Scenescape’s container images available, either built from source or as prebuilt images.

I want to…

Steps

Deploy clean Scenescape on Docker

Preparation then Deploy on Docker

Deploy clean Scenescape on Kubernetes

Preparation then Deploy on Kubernetes

Explore the bundled demo (Docker or Kubernetes)

Preparation then Deploy the Demo

Note: The Kubernetes guides assume a cluster already exists and kubectl is configured with access to it. To spin up a local, self-contained cluster for development or evaluation instead, see Scenescape on Kubernetes.

Next Steps#

Explore other topics#

Additional Resources#