v2.6.0

![Swirl Logo](https://raw.githubusercontent.com/wiki/swirlai/swirl-search/images/transparent_header_3.png)

## Team Swirl is announcing General Availability of Swirl 2.6!

This release features new SearchProviders for [ServiceNow](https://www.servicenow.com/), [Google News](https://news.google.com/), and a searchable [Hacker News](https://hn.algolia.com/) implementation!  We've also validated Swirl on the latest stable Python version (*3.11.5*) and updated our `Dockerfile` image to the latest stable Debian release (*Bookworm*).

### :warning: As of Release 2.6, Swirl's start-up process no longer starts `redis`.  You must now have `redis` installed *and runnning* before starting Swirl.

![Release 2.5.1 New SearchProviders](https://raw.githubusercontent.com/wiki/swirlai/swirl-search/images/2_6-New_SPs-1.png)

### PLEASE STAR OUR REPO: [https://github.com/swirlai/swirl-search](https://github.com/swirlai/swirl-search)

<br/>

# New Features

:small_blue_diamond:  Search the ServiceNow Knowledge and Service Catalog centers using new Basic Auth SearchProviders.
* For the `credentials`, ServiceNow requries an admin level account for searching.
* Both the `url` and `result_mappings` require the ServiceNow instance domain.

:small_blue_diamond:  Search Google News posts with a dedicated SearchProvider for this source.

:small_blue_diamond: Search Stories and Comments from Hacker News with new SearchProviders for each.

:small_blue_diamond: Swirl now checks to see if you are running the latest version at startup.
```
You're using version 2.6 of Swirl, the current version.
```

# Improvements

:small_blue_diamond:  Swirl's installation script (`install.sh`) will now check for a running Redis instance and for the presence of `jq` on the system, and emit helpful messages if they are not found.

:small_blue_diamond:  Swirl 2.6 has been verified on the latest stable Python release (*3.11.5*).

:small_blue_diamond: The Debian image in Swirl's `Dockerfile` has been updated from `3.11.4-slim-bullseye` to `3.11.5-slim-bookworm`, which addresses several known vulnerabilities.

:small_blue_diamond:  Configuration for an `OPENAI_API_KEY` is now available in Swirl's `.env` file for use with the ChatGPT `query_processor` and `query_mappings` override options.

# Resolved Issues

:small_blue_diamond:  Removed an unecessary duplicate entry in `requirements.txt`

:small_blue_diamond:  Addressed common non-date formatting issues  in the `DateFinderResultProcessor`

:small_blue_diamond:  Removed unnessesary parameter from the query `url` of the EuropePMC SearchProvider

# Known Issues

:small_blue_diamond: Clicking a Microsoft Teams result sometimes results in this error from the Teams app:
```
We cannot take you to that message because it's in a chat you're not in.
```
For Teams links to resolve correctly, you must have the Microsoft Teams app open *before* clicking the result link.

:small_blue_diamond: [Creating searches from a browser with q=](https://github.com/swirlai/swirl-search/wiki/5.-Developer-Guide#create-a-search-object-with-the-q-url-parameter) can sometimes create two Search objects. 

This is because of browser prefetch AKA predictive service. [Turn off Chrome prediction service](https://www.ghacks.net/2019/04/23/missing-chromes-use-a-prediction-service-setting/). [Turn off Safari prefetch](https://stackoverflow.com/questions/29214246/how-to-turn-off-safaris-prefetch-feature).

Please report any issues with this to [support](#support).


# Upgrading

:warning:  Version 2.6 does not require a database migration.

### :warning: As of version 2.6, Swirl's start-up process no longer starts `redis`.  You must now have `redis` installed *and runnning* before starting Swirl.


# Documentation

[Overview](https://docs.swirl.today/) | [Quick Start](https://docs.swirl.today/1.-Quick-Start) | [User Guide](https://docs.swirl.today/2.-User-Guide) | [Admin Guide](https://docs.swirl.today/3.-Admin-Guide) | [M365 Guide](https://docs.swirl.today/4.-M365-Guide) | [Developer Guide](https://docs.swirl.today/5.-Developer-Guide) | [Developer Reference](https://docs.swirl.today/6.-Developer-Reference)
_(updated links on 13-October-2023)_

# Support

:small_blue_diamond: [Join the Swirl Community on Slack!](https://join.slack.com/t/swirlmetasearch/shared_invite/zt-1qk7q02eo-kpqFAbiZJGOdqgYVvR1sfw)

:small_blue_diamond: Email: [support@swirl.today](mailto:support@swirl.today) with issues, requests, questions, etc - we'd love to hear from you!

<br/>