https://github.com/beam-community/redbird

A Redis adapter for Plug.Session
https://github.com/beam-community/redbird

elixir elixir-phoenix redis

Last synced: 14 days ago
JSON representation

A Redis adapter for Plug.Session

• Host: GitHub
• URL: https://github.com/beam-community/redbird
• Owner: beam-community
• License: mit
• Created: 2017-01-20T19:22:22.000Z (almost 8 years ago)
• Default Branch: main
• Last Pushed: 2024-04-30T03:15:54.000Z (7 months ago)
• Last Synced: 2024-10-17T17:14:03.064Z (28 days ago)
• Topics: elixir, elixir-phoenix, redis
• Language: Elixir
• Size: 307 KB
• Stars: 70
• Watchers: 6
• Forks: 19
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![CircleCI](https://circleci.com/gh/thoughtbot/redbird.svg?style=svg&circle-token=ffeb06ba85ab9e15f98730027745be851d647b61&branch=master)](https://circleci.com/gh/thoughtbot/redbird)

# Redbird

**Redbird is part of the [thoughtbot Elixir family][elixir-phoenix] of projects.**

Redbird is a Redis session adapter for Plug.Session.

It works great for Phoenix!

## Installation

### Add Redbird to your dependency list.

```elixir

  def deps do

    [

      {:redbird, "~> 0.7.1"},

    ]

  end

```

### Configure Plug

```elixir

plug Plug.Session,

  store: :redis,

  key: "_app_key",

  expiration_in_seconds: 3000 # Optional - default is 30 days

```

### Configure Redbird

All redbird created keys are automatically namespaced with `redbird_session` by

default. If you'd like to set your own custom, per app, configuration you can

set that in the config.

```elixir

config :redbird, key_namespace: "my_app_"

```

### Configure Redix

Redbird uses [Redix] to communicate with Redis. You can pass configuration

options as `redis_options`:

```elixir

config :redbird,

  redis_options: [

    host: System.get_env("REDIS_HOST"),

    port: System.get_env("REDIS_PORT"),

    password: System.get_env("REDIS_PASSWORD"),

    ssl: true

  ]

```

For a full list of configuration options, please see [Redix's connection

options].

  [Redix]: https://hexdocs.pm/redix/Redix.html

  [Redix's connection options]: https://hexdocs.pm/redix/Redix.html#start_link/1-connection-options

### Mix Tasks

This will give you access to the mix task `mix redbird.delete_all_sessions`, for

clearing all Redbird created user sessions from Redis. If you have not set up a

per app `key_namespace` in the config this will clear ALL Redbird sessions on

your server. Otherwise it will only clear the sessions created by the specific

app you're running it in.

## Contributing

See the [CONTRIBUTING] document.

Thank you, [contributors]!

  [CONTRIBUTING]: CONTRIBUTING.md

  [contributors]: https://github.com/thoughtbot/redbird/graphs/contributors

## License

Redbird is Copyright (c) 2017-2020 thoughtbot, inc.

It is free software, and may be redistributed

under the terms specified in the [LICENSE] file.

  [LICENSE]: /LICENSE

## About

![thoughtbot](http://presskit.thoughtbot.com/images/thoughtbot-logo-for-readmes.svg)

Redbird is maintained and funded by thoughtbot, inc.

The names and logos for thoughtbot are trademarks of thoughtbot, inc.

We love open source software, Elixir, and Phoenix. See [our other Elixir

projects][elixir-phoenix], or [hire our Elixir Phoenix development team][hire]

to design, develop, and grow your product.

  [elixir-phoenix]: https://thoughtbot.com/services/elixir-phoenix?utm_source=github

  [hire]: https://thoughtbot.com?utm_source=github