From 37c9a96d2a5897042f30becfbd30943725631090 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rapha=C3=ABl=20Bournhonesque?= Date: Thu, 1 Feb 2024 10:53:03 +0100 Subject: [PATCH] doc: add basic documentation --- docs/.pages | 3 +++ docs/README.md | 3 +++ docs/install.md | 12 ++++++++++++ 3 files changed, 18 insertions(+) create mode 100644 docs/.pages create mode 100644 docs/README.md create mode 100644 docs/install.md diff --git a/docs/.pages b/docs/.pages new file mode 100644 index 00000000..e6e673ec --- /dev/null +++ b/docs/.pages @@ -0,0 +1,3 @@ +nav: + - README.md + - "Install": install.md \ No newline at end of file diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..5d4aecb2 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,3 @@ +# Search-a-licious + +Welcome to the documentation of search-a-licious, a versatile search engine built on top of [Elasticsearch](https://www.elastic.co/). diff --git a/docs/install.md b/docs/install.md new file mode 100644 index 00000000..65bae767 --- /dev/null +++ b/docs/install.md @@ -0,0 +1,12 @@ +# Install search-a-licious + +search-a-licious uses docker and docker-compose to manage the services it needs to run. You will need to install both of these before you can use search-a-licious. + +Once docker is installed, clone the git repository locally. + +All configuration are passed through environment variables to services through the use of a .env file. A default .env file is provided in the repository, you will need to edit this file to suit your needs. + +The only required change is to set the `CONFIG_PATH` variable to the path of your YAML configuration file. This file is used to configure the search-a-licious indexer and search services. + + +