https://github.com/voltone/aws_rds_castore
AWS RDS CA certificate store for Elixir
https://github.com/voltone/aws_rds_castore
Last synced: about 1 year ago
JSON representation
AWS RDS CA certificate store for Elixir
- Host: GitHub
- URL: https://github.com/voltone/aws_rds_castore
- Owner: voltone
- Created: 2023-04-03T07:59:57.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-11T07:42:56.000Z (over 1 year ago)
- Last Synced: 2025-04-23T12:06:39.964Z (about 1 year ago)
- Language: Elixir
- Size: 92.8 KB
- Stars: 21
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# AwsRdsCAStore
[](https://github.com/voltone/aws_rds_castore/actions)
[](https://hex.pm/packages/aws_rds_castore)
[](https://hexdocs.pm/aws_rds_castore/)
[](https://hex.pm/packages/aws_rds_castore)
[](https://hex.pm/packages/aws_rds_castore)
[](https://github.com/voltone/aws_rds_castore/commits/master)
AWS RDS CA certificate store for Elixir and Erlang. See https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html
Based on and derived from https://hex.pm/packages/castore
## Installation
### Elixir (Mix)
In your `mix.exs`:
```elixir
def deps do
[
{:aws_rds_castore, "~> 1.1"}
]
end
```
Then, run `$ mix deps.get`.
### Erlang (Rebar3)
In your `rebar.config`:
```erlang
{deps, [
{aws_rds_castore, "~> 1.1"}
]}.
```
Then, run `$ rebar3 get-deps`.
## Usage
### Elixir (with Ecto)
```elixir
# In runtime.exs:
config :my_app, MyApp.Repo,
url: database_url,
ssl: AwsRdsCAStore.ssl_opts(database_url),
pool_size: String.to_integer(System.get_env("POOL_SIZE") || "10"),
socket_options: maybe_ipv6
```
See [the documentation](https://hexdocs.pm/aws_rds_castore).
### Erlang (with PGo)
```erlang
PoolConfig = #{pool_size => 10,
host => Host,
database => "test",
user => "test",
ssl => true,
ssl_options => aws_rds_castore:ssl_opts(Host)},
pgo:start_pool(default, PoolConfig).
```
## Updates
Every time there is an update to the AWS RDS CA certificate store, we'll release a new **patch version** of the library. For example, `1.1.12` → `1.1.13`.
## Contributing
If you want to locally update the CA certificate store file bundled with this library, run the `mix aws_rds_ca_store.certdata` from the root of this library.
## License
Copyright 2022 Bram Verburg
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.