mirror of
https://github.com/actix/actix-extras.git
synced 2024-11-23 23:51:06 +01:00
48 lines
1.7 KiB
Markdown
48 lines
1.7 KiB
Markdown
# actix-redis
|
|
|
|
> Redis integration for Actix and session store for Actix Web.
|
|
|
|
[](https://crates.io/crates/actix-redis)
|
|
[](https://docs.rs/actix-redis/0.10.0-beta.6)
|
|
|
|
[](https://deps.rs/crate/actix-redis/0.10.0-beta.6)
|
|
|
|
## Documentation & Resources
|
|
|
|
- [API Documentation](https://docs.rs/actix-redis)
|
|
- [Example Project](https://github.com/actix/examples/tree/master/auth/redis-session)
|
|
- Minimum Supported Rust Version (MSRV): 1.54
|
|
|
|
## Redis Session Backend
|
|
|
|
Use redis as session storage.
|
|
|
|
You need to pass an address of the redis server and random value to the
|
|
constructor of `RedisSession`. This is private key for cookie session,
|
|
When this value is changed, all session data is lost.
|
|
|
|
Note that whatever you write into your session is visible by the user (but not modifiable).
|
|
|
|
Constructor panics if key length is less than 32 bytes.
|
|
|
|
```rust
|
|
use actix_web::{App, HttpServer, middleware::Logger};
|
|
use actix_web::web::{resource, get}
|
|
use actix_redis::RedisSession;
|
|
|
|
#[actix_web::main]
|
|
async fn main() -> std::io::Result<()> {
|
|
HttpServer::new(move || App::new()
|
|
// cookie session middleware
|
|
.wrap(RedisSession::new("127.0.0.1:6379", &[0; 32]))
|
|
// enable logger
|
|
.wrap(Logger::default())
|
|
// register simple route, handle all methods
|
|
.service(resource("/").route(get().to(index)))
|
|
)
|
|
.bind("127.0.0.1:8080")?
|
|
.run()
|
|
.await
|
|
}
|
|
```
|