Skip to content

Conversation

@andrewbbaek
Copy link
Contributor

Updated the SearXNG Web Search documentation to improve the Docker setup guide.

This update reflects recent changes made in the searxng-docker repository and removes unnecessary steps to make it easier for the community to follow.

Key changes include:

  • Removed the searxng-docker prefix from file paths and adjusted commands to be run inside the directory.
  • Added commands for macOS users for easier copy and use.
  • Manually creating a secret key is no longer necessary. It’s automatically generated when settings.yml is created after deleting the default file.
  • Removed the part about updating port and bind_address in settings.yml as these settings have no effect when running with Docker. They only take effect when running the service directly with Python, as noted in the official SearXNG documentation. The port setting is only relevant in the docker-compose.yaml file, where the Docker container port should be set to 8080, along with an available host port.
  • Added some extra instructions based on issues I encountered while following the guide.

I ran the setup multiple times following the updated documentation to ensure it works as expected.

@pr-validator-bot
Copy link

ℹ️ Documentation PR Guidelines

👋 Welcome! This is an automated message posted on all new documentation PRs to help guide our contributors. Just because this comment appeared doesn't mean you have done anything wrong!

Please ensure you're using the correct branches:

Target branch (where you're merging TO):

  • dev branch: For documentation related to upcoming Open WebUI releases (new features, new environment variables, anything dependent on unreleased versions and unreleased features/fixes/changes)
  • main branch: For content that can go live immediately (fixes, tutorials, documentation not dependent on unreleased features)

Source branch (where you're merging FROM):

  • If targeting dev, create your branch from your fork's dev branch
  • If targeting main, create your branch from your fork's main branch
  • ⚠️ Mismatched branches can result in unwanted file changes being included in your PR!

If your docs PR depends on a pending PR in open-webui/open-webui:

  • Convert this PR to DRAFT mode!
  • Link to the related main repo PR in your description for clarity
  • We'll review both together once the PR on the main repo is merged

Please adjust your PR target branch, source branch, and/or draft status accordingly if needed.


7. Bring up the container momentarily to generate a fresh settings.yml file:

If the container name caddy, redis, searxng is already in use, change it to another name of your choice in the docker-compose.yaml file.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

redis:
    container_name: redis
    image: docker.io/valkey/valkey:8-alpine
    command: valkey-server --save 30 1 --loglevel warning
    restart: unless-stopped
    networks:
      - searxng
    volumes:
      - valkey-data2:/data
    logging:
      driver: "json-file"
      options:
        max-size: "1m"
        max-file: "1"

When I first cloned the repo, the docker-compose.yaml had the service and container named redis but was actually using the valkey image (They are similar but not same). Since I already had another container running with the name redis, I changed the container name here to avoid conflicts when running docker-compose. I thought mentioning this might help beginners who are not familiar with Docker errors.

I mentioned all the names just in case there might be containers with the same name running.

Do you think it would be better to remove it? Feel free to give me any feedback!

Copy link
Collaborator

@Classic298 Classic298 Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aha. I would perhaps clarify that.
"If you have multiple containers... then you need to..."
"If a container name is already in use, change it to another name of your choice..."

@Classic298
Copy link
Collaborator

@andrewbbaek

In Step 3, you instruct the user to configure the port to 0.0.0.0:8080. However, in Step 7, the docker-compose.yaml code block introduces a completely new port binding:

ports:

  • "0.0.0.0:9630:8080"

You might want to mention that if the user is running Open WebUI on the same Docker network, they don't necessarily need to bind 0.0.0.0; they can just use the container name searxng.

@Classic298
Copy link
Collaborator

LGTM! THANKS @andrewbbaek

@Classic298 Classic298 merged commit ac56920 into open-webui:main Nov 28, 2025
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants