diff --git a/README.md b/README.md index ba8bf42b..6dc3d7da 100644 --- a/README.md +++ b/README.md @@ -9,26 +9,7 @@ requiring datacenters and expensive enterprise hardware, to run this operation o ## Set up instructions -For local development, you're strongly encouraged to use docker or podman. -From a fresh to running system, you'll need to do this: - -``` -$ ./gradlew assemble - -$ ./gradlew docker - -$ vim run/settings.profile - -(follow instructions in file) - -$ run/setup.sh - -$ run/reconvert.sh - -$ docker-compose up -``` - -Wait a moment and check out [https://localhost:8080](https://localhost:8080). +Follow instructions in [run](run/). ## Documentation diff --git a/run/readme.md b/run/readme.md new file mode 100644 index 00000000..5a9b9ce5 --- /dev/null +++ b/run/readme.md @@ -0,0 +1,28 @@ +# Run + +When developing locally, this directory will contain run-time data required for +the search engine. In a clean check-out, it only contains the tools required to +bootstrap this directory structure. + +## Set up + +While the system is designed to run bare metal in production, +for local development, you're strongly encouraged to use docker +or podman. + +From a fresh to running system, you'll need to do this: + +From the project root +``` +$ ./gradlew assemble docker + +$ run/setup.sh + +$ docker-compose up -d mariadb + +$ run/reconvert.sh + +$ docker-compose up +``` + +Wait a moment and check out [http://localhost:8080](http://localhost:8080). diff --git a/run/setup.sh b/run/setup.sh new file mode 100755 index 00000000..4ab3a74e --- /dev/null +++ b/run/setup.sh @@ -0,0 +1,7 @@ +#!/bin/bash + +set -e + +pushd $(dirname $0) + +popd