(docs) Amend install instructions for non-docker install

This commit is contained in:
Viktor Lofgren 2024-06-16 10:22:07 +02:00
parent 2168b7cf7d
commit 54caf17107

View File

@ -149,7 +149,11 @@ elif [ "${INSTANCE_TYPE}" == "4" ]; then
envsubst < install/docker-compose-scaffold.yml.template >${INSTALL_DIR}/docker-compose.yml
cat <<EOF > ${INSTALL_DIR}/README
Quick note about running Marginalia Search in a non-docker environment:
Quick note about running Marginalia Search in a non-docker environment.
This installation mode is not recommended, as it is significantly more complex
to set up and maintain: You will need to manage the services yourself, including
port management.
* The template sets up a sample (in-docker) setup for
mariadb and zookeeper. These can also be run outside
@ -177,13 +181,16 @@ A working setup needs at all the services
* index [ http port is internal ]
* executor [ http port is internal ]
The index and executor services should be on the same partition e.g. index:1 and executor:1,
which should be a number larger than 0. You can have multiple pairs of index and executor partitions,
but the pair should run on the same physical machine with the same install directory.
Since you will need to manage ports yourself, you must assign distinct ports-pairs to each service.
The query service can use any partition number.
* An index and executor services should exist on the same partition e.g. index:1 and executor:1. The partition
number is the last digit of the service name, and should be positive. You can have multiple pairs of index
and executor partitions, but the pair should run on the same physical machine with the same install directory.
* The query service can use any partition number.
* The control service should be on partition 1.
The control service should be on partition 1.
EOF
echo