Skip to content

Repository files navigation

myZrvr-Example

A basic example how to use Zrvr

Local Development & Build Guide

Prerequisites

  • Docker and Docker Compose installed
  • (Optional) Bash for running helper scripts

Build and Run

  1. Build the Zrvr Docker image:
    SCRIPTS_CHECKSUM=$(./Zrvr/scripts/external/calculate-checksum.sh)
    docker build -t terra -f ./Zrvr/Dockerfile . --build-arg APP_PATH=Terra --build-arg SCRIPTS_CHECKSUM=$SCRIPTS_CHECKSUM
  2. Start all services using Docker Compose:
    docker-compose -f docker-compose-prod.yml up
  3. To stop the services:
    docker-compose -f docker-compose-prod.yml down

Notes

  • Make sure all required plugin/config files are present in the correct folders before building.
  • The compose file references images from ghcr.io. For local development, you may need to build/tag your own images or adjust the image names.
  • Scripts for plugin management and setup are in Zrvr/scripts/.

For more details, see Zrvr/README.md.

Important

In the case that the Zrvr folder has not been cloned for some reason use the

git submodule update --init --recursive

command in the root of the repository.

About

A basic example how to use Zrvr

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors