diff options
| author | Markus Heiser <markus.heiser@darmarit.de> | 2020-12-21 00:37:45 +0100 |
|---|---|---|
| committer | Markus Heiser <markus.heiser@darmarit.de> | 2021-01-11 22:12:38 +0100 |
| commit | 9485179064b4eb28f2813eba3c295edca3b0db7f (patch) | |
| tree | e9f5f003e9887aa130a3f19d82a1d9ace898504b /docs/admin | |
| parent | dbfd5567aaa06a5f9792bb0839af74877ed5258c (diff) | |
[mod] move brand options from Makefile to settings.yml
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/admin')
| -rw-r--r-- | docs/admin/installation.rst | 2 | ||||
| -rw-r--r-- | docs/admin/settings.rst | 24 |
2 files changed, 25 insertions, 1 deletions
diff --git a/docs/admin/installation.rst b/docs/admin/installation.rst index 4a301ecf8..8a066dec7 100644 --- a/docs/admin/installation.rst +++ b/docs/admin/installation.rst @@ -76,6 +76,6 @@ If all services are running fine, you can add it to your HTTP server: .. tip:: About script's installation options have a look at chapter :ref:`toolboxing - setup`. How to brand your instance see chapter :ref:`makefile setup`. To + setup`. How to brand your instance see chapter :ref:`settings global`. To *stash* your instance's setup, `git stash`_ your clone's :origin:`Makefile` and :origin:`.config.sh` file . diff --git a/docs/admin/settings.rst b/docs/admin/settings.rst index 985c16f85..cc4007d2f 100644 --- a/docs/admin/settings.rst +++ b/docs/admin/settings.rst @@ -40,11 +40,35 @@ Global Settings general: debug : False # Debug mode, only for development instance_name : "searx" # displayed name + git_url: https://github.com/searx/searx + git_branch: master + issue_url: https://github.com/searx/searx/issues + docs_url: https://searx.github.io/searx + public_instances: https://searx.space + contact_url: False # mailto:contact@example.com + wiki_url: https://github.com/searx/searx/wiki + twitter_url: https://twitter.com/Searx_engine ``debug`` : Allow a more detailed log if you run searx directly. Display *detailed* error messages in the browser too, so this must be deactivated in production. +``contact_url``: + Contact mail address or WEB form. + +``git_url`` and ``git_branch``: + Changes this, to point to your searx fork (branch). + +``docs_url`` + If you host your own documentation, change this URL. + +``wiki_url``: + Link to your wiki (or ``False``) + +``twitter_url``: + Link to your tweets (or ``False``) + + .. code:: yaml server: |