Skip to content

Commit

Permalink
Add notes to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lloydwatkin committed Apr 29, 2024
1 parent 50fd4a6 commit 91566ca
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ Janus is heavily inspired by [Makara](https://github.com/instacart/makara) from

Learn more about its origins: [https://tech.olioex.com/ruby/2024/04/16/introducing-janus.html](https://tech.olioex.com/ruby/2024/04/16/introducing-janus.html).

Notes: GEM is currently tested with MySQL 8, Ruby 3.2, ActiveRecord 7.1+

## Installation

Use the current version of the gem from [rubygems](https://rubygems.org/gems/janus-ar) in your `Gemfile`.
Expand Down Expand Up @@ -58,6 +60,11 @@ Note: For `trilogy` please use adapter "janus_trilogy". You'll probably need to
tls_min_version: 3
```

`tls_min_version` here refers to TLS1.2.

Otherwise you will get an error like the following (see https://github.com/trilogy-libraries/trilogy/issues/26):
> trilogy_auth_recv: caching_sha2_password requires either TCP with TLS or a unix socket: TRILOGY_UNSUPPORTED"

### Forcing connections

A context is local to the curent thread of execution. This will allow you to stick to the primary safely in a single thread
Expand Down

0 comments on commit 91566ca

Please sign in to comment.