doc: add basic documentation

openfoodfacts · Feb 1, 2024 · 37c9a96 · 37c9a96
1 parent 65018f3
commit 37c9a96
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 0 deletions.
diff --git a/docs/.pages b/docs/.pages
@@ -0,0 +1,3 @@
+nav:
+    - README.md
+    - "Install": install.md
diff --git a/docs/README.md 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
@@ -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.
+
+
+
Original file line number	Diff line number	Diff line change
		@@ -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/).