cloudserve-infrastructure/roles/searx/README.md

1.4 KiB

searx

A self-hosted privacy-oriented metasearch engine.

Defaults

searx_upstream_file_dir: "{{ docker_stack_files_dir }}/{{ stack_name }}"

The on-target directory where the proxy configuration file should be stashed.

searx_use_https: true

Whether the service should be reachable through http (port 80) or through https (port 443) and provision an https certificate. Usually you will want this to stay true.

searx_version: latest

The docker image version to be used in stack creation.

subdomain_alias: search

If the deployed container should be served over a uri that is not the stack name. By default, it will be set to search.yourdomain.com - if this option is not set it will be served on searx.yourdomain.com instead.

searx_authentication:
    - username: mysearxusername
      password: <hashed basicauth password>

By default, the searx instance is not protected with a login, however you can have caddy provide a basic auth login form by using this variable.

You can either change the login to suit you by generating a combination (or multiple, it will also work with an arbitrary amount of logins), or remove the necessity to login altogether by not setting the searx_authentication variable to anything.

The password needs to be in a hashed format, which is easiest to accomplish with the help of caddy itself --- simply doing caddy hash-password will allow you to create a new hashed password.