From 1b3f0c848e9e9785635f19e4c935a9a0a8d4f7f9 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Thu, 3 Jun 2021 09:53:28 +0200 Subject: [PATCH] [docs] move blog article "SQL engines" to admin/engines/ The article "SQL engines" should be in admin's engine documentation (like the recoll engine). Signed-off-by: Markus Heiser --- docs/admin/engines.rst | 1 + docs/{blog => admin/engines}/sql-engines.rst | 31 +++++++++++++------- docs/blog/index.rst | 1 - 3 files changed, 21 insertions(+), 12 deletions(-) rename docs/{blog => admin/engines}/sql-engines.rst (89%) diff --git a/docs/admin/engines.rst b/docs/admin/engines.rst index 520fda35c..c7461d3fd 100644 --- a/docs/admin/engines.rst +++ b/docs/admin/engines.rst @@ -14,6 +14,7 @@ Special Engine Settings :maxdepth: 1 engines/recoll + engines/sql-engines engines/command-line-engines diff --git a/docs/blog/sql-engines.rst b/docs/admin/engines/sql-engines.rst similarity index 89% rename from docs/blog/sql-engines.rst rename to docs/admin/engines/sql-engines.rst index 413316054..ee7f31c27 100644 --- a/docs/blog/sql-engines.rst +++ b/docs/admin/engines/sql-engines.rst @@ -1,5 +1,7 @@ +.. _sql engines: + =========== -SQL engines +SQL Engines =========== .. sidebar:: further read @@ -36,9 +38,10 @@ place the templates at:: searx/templates/{theme_name}/result_templates/{template_name} -As mentioned in previous blog posts, if you do not wish to expose these engines -on a public instance, you can still add them and limit the access by setting -``tokens`` as described in section :ref:`private engines`. +If you do not wish to expose these engines on a public instance, you can still +add them and limit the access by setting ``tokens`` as described in section +:ref:`private engines`. + Configure the engines ===================== @@ -58,6 +61,10 @@ returned results use the option ``limit``. SQLite ------ +.. sidebar:: info + + - :origin:`sqlite.py ` + .. _MediathekView: https://mediathekview.de/ SQLite is a small, fast and reliable SQL database engine. It does not require @@ -106,9 +113,10 @@ PostgreSQL .. _psycopg2: https://www.psycopg.org/install -.. sidebar:: requirements +.. sidebar:: info - ``pip install`` psycopg2_ + - :origin:`postgresql.py ` + - ``pip install`` psycopg2_ PostgreSQL is a powerful and robust open source database. Before configuring the PostgreSQL engine, you must install the dependency ``psychopg2``. You can @@ -130,9 +138,10 @@ MySQL .. _mysql-connector-python: https://pypi.org/project/mysql-connector-python -.. sidebar:: requirements +.. sidebar:: info - ``pip install`` mysql-connector-python_ + - :origin:`mysql_server.py ` + - ``pip install`` mysql-connector-python_ MySQL is said to be the most popular open source database. Before enabling MySQL engine, you must install the package ``mysql-connector-python``. @@ -152,9 +161,9 @@ example configuration for quering a MySQL server: query_str: 'SELECT * from my_table WHERE my_column=%(query)s' -Acknowledgement -=============== +Acknowledgment +============== This development was sponsored by `Search and Discovery Fund -`_ of `NLnet Foundation `_ . +`_ of `NLnet Foundation `_. diff --git a/docs/blog/index.rst b/docs/blog/index.rst index 2817f3b2b..a870c78c6 100644 --- a/docs/blog/index.rst +++ b/docs/blog/index.rst @@ -11,4 +11,3 @@ Blog intro-offline private-engines search-indexer-engines - sql-engines