{"id":13601469,"url":"https://github.com/gin-contrib/sessions","last_synced_at":"2025-05-14T07:08:18.545Z","repository":{"id":14068456,"uuid":"73276880","full_name":"gin-contrib/sessions","owner":"gin-contrib","description":"Gin middleware for session management","archived":false,"fork":false,"pushed_at":"2024-06-18T08:20:46.000Z","size":1022,"stargazers_count":1449,"open_issues_count":105,"forks_count":194,"subscribers_count":16,"default_branch":"master","last_synced_at":"2024-10-29T11:29:12.839Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gin-contrib.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-11-09T11:09:42.000Z","updated_at":"2024-10-28T07:51:50.000Z","dependencies_parsed_at":"2024-01-13T10:13:48.031Z","dependency_job_id":"980def89-1537-4cb3-a352-f0319f0d60bb","html_url":"https://github.com/gin-contrib/sessions","commit_stats":{"total_commits":130,"total_committers":28,"mean_commits":4.642857142857143,"dds":0.4076923076923077,"last_synced_commit":"4814ef52395a0762cd27afc049b3b38e56a28abe"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gin-contrib%2Fsessions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gin-contrib%2Fsessions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gin-contrib%2Fsessions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gin-contrib%2Fsessions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gin-contrib","download_url":"https://codeload.github.com/gin-contrib/sessions/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254092659,"owners_count":22013290,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T18:01:03.161Z","updated_at":"2025-05-14T07:08:18.524Z","avatar_url":"https://github.com/gin-contrib.png","language":"Go","readme":"# sessions\n\n[![Run CI Lint](https://github.com/gin-contrib/sessions/actions/workflows/lint.yml/badge.svg?branch=master)](https://github.com/gin-contrib/sessions/actions/workflows/lint.yml)\n[![Run Testing](https://github.com/gin-contrib/sessions/actions/workflows/testing.yml/badge.svg?branch=master)](https://github.com/gin-contrib/sessions/actions/workflows/testing.yml)\n[![codecov](https://codecov.io/gh/gin-contrib/sessions/branch/master/graph/badge.svg)](https://codecov.io/gh/gin-contrib/sessions)\n[![Go Report Card](https://goreportcard.com/badge/github.com/gin-contrib/sessions)](https://goreportcard.com/report/github.com/gin-contrib/sessions)\n[![GoDoc](https://godoc.org/github.com/gin-contrib/sessions?status.svg)](https://godoc.org/github.com/gin-contrib/sessions)\n\nGin middleware for session management with multi-backend support:\n\n- [cookie-based](#cookie-based)\n- [Redis](#redis)\n- [memcached](#memcached)\n- [MongoDB](#mongodb)\n- [GORM](#gorm)\n- [memstore](#memstore)\n- [PostgreSQL](#postgresql)\n\n## Usage\n\n### Start using it\n\nDownload and install it:\n\n```bash\ngo get github.com/gin-contrib/sessions\n```\n\nImport it in your code:\n\n```go\nimport \"github.com/gin-contrib/sessions\"\n```\n\n## Basic Examples\n\n### single session\n\n```go\npackage main\n\nimport (\n  \"github.com/gin-contrib/sessions\"\n  \"github.com/gin-contrib/sessions/cookie\"\n  \"github.com/gin-gonic/gin\"\n)\n\nfunc main() {\n  r := gin.Default()\n  store := cookie.NewStore([]byte(\"secret\"))\n  r.Use(sessions.Sessions(\"mysession\", store))\n\n  r.GET(\"/hello\", func(c *gin.Context) {\n    session := sessions.Default(c)\n\n    if session.Get(\"hello\") != \"world\" {\n      session.Set(\"hello\", \"world\")\n      session.Save()\n    }\n\n    c.JSON(200, gin.H{\"hello\": session.Get(\"hello\")})\n  })\n  r.Run(\":8000\")\n}\n```\n\n### multiple sessions\n\n```go\npackage main\n\nimport (\n  \"github.com/gin-contrib/sessions\"\n  \"github.com/gin-contrib/sessions/cookie\"\n  \"github.com/gin-gonic/gin\"\n)\n\nfunc main() {\n  r := gin.Default()\n  store := cookie.NewStore([]byte(\"secret\"))\n  sessionNames := []string{\"a\", \"b\"}\n  r.Use(sessions.SessionsMany(sessionNames, store))\n\n  r.GET(\"/hello\", func(c *gin.Context) {\n    sessionA := sessions.DefaultMany(c, \"a\")\n    sessionB := sessions.DefaultMany(c, \"b\")\n\n    if sessionA.Get(\"hello\") != \"world!\" {\n      sessionA.Set(\"hello\", \"world!\")\n      sessionA.Save()\n    }\n\n    if sessionB.Get(\"hello\") != \"world?\" {\n      sessionB.Set(\"hello\", \"world?\")\n      sessionB.Save()\n    }\n\n    c.JSON(200, gin.H{\n      \"a\": sessionA.Get(\"hello\"),\n      \"b\": sessionB.Get(\"hello\"),\n    })\n  })\n  r.Run(\":8000\")\n}\n```\n\n## Backend Examples\n\n### cookie-based\n\n```go\npackage main\n\nimport (\n  \"github.com/gin-contrib/sessions\"\n  \"github.com/gin-contrib/sessions/cookie\"\n  \"github.com/gin-gonic/gin\"\n)\n\nfunc main() {\n  r := gin.Default()\n  store := cookie.NewStore([]byte(\"secret\"))\n  r.Use(sessions.Sessions(\"mysession\", store))\n\n  r.GET(\"/incr\", func(c *gin.Context) {\n    session := sessions.Default(c)\n    var count int\n    v := session.Get(\"count\")\n    if v == nil {\n      count = 0\n    } else {\n      count = v.(int)\n      count++\n    }\n    session.Set(\"count\", count)\n    session.Save()\n    c.JSON(200, gin.H{\"count\": count})\n  })\n  r.Run(\":8000\")\n}\n```\n\n### Redis\n\n```go\npackage main\n\nimport (\n  \"github.com/gin-contrib/sessions\"\n  \"github.com/gin-contrib/sessions/redis\"\n  \"github.com/gin-gonic/gin\"\n)\n\nfunc main() {\n  r := gin.Default()\n  store, _ := redis.NewStore(10, \"tcp\", \"localhost:6379\", \"\", []byte(\"secret\"))\n  r.Use(sessions.Sessions(\"mysession\", store))\n\n  r.GET(\"/incr\", func(c *gin.Context) {\n    session := sessions.Default(c)\n    var count int\n    v := session.Get(\"count\")\n    if v == nil {\n      count = 0\n    } else {\n      count = v.(int)\n      count++\n    }\n    session.Set(\"count\", count)\n    session.Save()\n    c.JSON(200, gin.H{\"count\": count})\n  })\n  r.Run(\":8000\")\n}\n```\n\n### Memcached\n\n#### ASCII Protocol\n\n```go\npackage main\n\nimport (\n  \"github.com/bradfitz/gomemcache/memcache\"\n  \"github.com/gin-contrib/sessions\"\n  \"github.com/gin-contrib/sessions/memcached\"\n  \"github.com/gin-gonic/gin\"\n)\n\nfunc main() {\n  r := gin.Default()\n  store := memcached.NewStore(memcache.New(\"localhost:11211\"), \"\", []byte(\"secret\"))\n  r.Use(sessions.Sessions(\"mysession\", store))\n\n  r.GET(\"/incr\", func(c *gin.Context) {\n    session := sessions.Default(c)\n    var count int\n    v := session.Get(\"count\")\n    if v == nil {\n      count = 0\n    } else {\n      count = v.(int)\n      count++\n    }\n    session.Set(\"count\", count)\n    session.Save()\n    c.JSON(200, gin.H{\"count\": count})\n  })\n  r.Run(\":8000\")\n}\n```\n\n#### Binary protocol (with optional SASL authentication)\n\n```go\npackage main\n\nimport (\n  \"github.com/gin-contrib/sessions\"\n  \"github.com/gin-contrib/sessions/memcached\"\n  \"github.com/gin-gonic/gin\"\n  \"github.com/memcachier/mc\"\n)\n\nfunc main() {\n  r := gin.Default()\n  client := mc.NewMC(\"localhost:11211\", \"username\", \"password\")\n  store := memcached.NewMemcacheStore(client, \"\", []byte(\"secret\"))\n  r.Use(sessions.Sessions(\"mysession\", store))\n\n  r.GET(\"/incr\", func(c *gin.Context) {\n    session := sessions.Default(c)\n    var count int\n    v := session.Get(\"count\")\n    if v == nil {\n      count = 0\n    } else {\n      count = v.(int)\n      count++\n    }\n    session.Set(\"count\", count)\n    session.Save()\n    c.JSON(200, gin.H{\"count\": count})\n  })\n  r.Run(\":8000\")\n}\n```\n\n### MongoDB\n\n#### mgo\n\n```go\npackage main\n\nimport (\n  \"github.com/gin-contrib/sessions\"\n  \"github.com/gin-contrib/sessions/mongo/mongomgo\"\n  \"github.com/gin-gonic/gin\"\n  \"github.com/globalsign/mgo\"\n)\n\nfunc main() {\n  r := gin.Default()\n  session, err := mgo.Dial(\"localhost:27017/test\")\n  if err != nil {\n    // handle err\n  }\n\n  c := session.DB(\"\").C(\"sessions\")\n  store := mongomgo.NewStore(c, 3600, true, []byte(\"secret\"))\n  r.Use(sessions.Sessions(\"mysession\", store))\n\n  r.GET(\"/incr\", func(c *gin.Context) {\n    session := sessions.Default(c)\n    var count int\n    v := session.Get(\"count\")\n    if v == nil {\n      count = 0\n    } else {\n      count = v.(int)\n      count++\n    }\n    session.Set(\"count\", count)\n    session.Save()\n    c.JSON(200, gin.H{\"count\": count})\n  })\n  r.Run(\":8000\")\n}\n```\n\n#### mongo-driver\n\n```go\npackage main\n\nimport (\n  \"context\"\n  \"github.com/gin-contrib/sessions\"\n  \"github.com/gin-contrib/sessions/mongo/mongodriver\"\n  \"github.com/gin-gonic/gin\"\n  \"go.mongodb.org/mongo-driver/mongo\"\n  \"go.mongodb.org/mongo-driver/mongo/options\"\n)\n\nfunc main() {\n  r := gin.Default()\n  mongoOptions := options.Client().ApplyURI(\"mongodb://localhost:27017\")\n  client, err := mongo.NewClient(mongoOptions)\n  if err != nil {\n    // handle err\n  }\n\n  if err := client.Connect(context.Background()); err != nil {\n    // handle err\n  }\n\n  c := client.Database(\"test\").Collection(\"sessions\")\n  store := mongodriver.NewStore(c, 3600, true, []byte(\"secret\"))\n  r.Use(sessions.Sessions(\"mysession\", store))\n\n  r.GET(\"/incr\", func(c *gin.Context) {\n    session := sessions.Default(c)\n    var count int\n    v := session.Get(\"count\")\n    if v == nil {\n      count = 0\n    } else {\n      count = v.(int)\n      count++\n    }\n    session.Set(\"count\", count)\n    session.Save()\n    c.JSON(200, gin.H{\"count\": count})\n  })\n  r.Run(\":8000\")\n}\n```\n\n### memstore\n\n```go\npackage main\n\nimport (\n  \"github.com/gin-contrib/sessions\"\n  \"github.com/gin-contrib/sessions/memstore\"\n  \"github.com/gin-gonic/gin\"\n)\n\nfunc main() {\n  r := gin.Default()\n  store := memstore.NewStore([]byte(\"secret\"))\n  r.Use(sessions.Sessions(\"mysession\", store))\n\n  r.GET(\"/incr\", func(c *gin.Context) {\n    session := sessions.Default(c)\n    var count int\n    v := session.Get(\"count\")\n    if v == nil {\n      count = 0\n    } else {\n      count = v.(int)\n      count++\n    }\n    session.Set(\"count\", count)\n    session.Save()\n    c.JSON(200, gin.H{\"count\": count})\n  })\n  r.Run(\":8000\")\n}\n```\n\n### GORM\n\n```go\npackage main\n\nimport (\n  \"github.com/gin-contrib/sessions\"\n  gormsessions \"github.com/gin-contrib/sessions/gorm\"\n  \"github.com/gin-gonic/gin\"\n  \"gorm.io/driver/sqlite\"\n  \"gorm.io/gorm\"\n)\n\nfunc main() {\n  db, err := gorm.Open(sqlite.Open(\"test.db\"), \u0026gorm.Config{})\n  if err != nil {\n    panic(err)\n  }\n  store := gormsessions.NewStore(db, true, []byte(\"secret\"))\n\n  r := gin.Default()\n  r.Use(sessions.Sessions(\"mysession\", store))\n\n  r.GET(\"/incr\", func(c *gin.Context) {\n    session := sessions.Default(c)\n    var count int\n    v := session.Get(\"count\")\n    if v == nil {\n      count = 0\n    } else {\n      count = v.(int)\n      count++\n    }\n    session.Set(\"count\", count)\n    session.Save()\n    c.JSON(200, gin.H{\"count\": count})\n  })\n  r.Run(\":8000\")\n}\n```\n\n### PostgreSQL\n\n```go\npackage main\n\nimport (\n  \"database/sql\"\n  \"github.com/gin-contrib/sessions\"\n  \"github.com/gin-contrib/sessions/postgres\"\n  \"github.com/gin-gonic/gin\"\n)\n\nfunc main() {\n  r := gin.Default()\n  db, err := sql.Open(\"postgres\", \"postgresql://username:password@localhost:5432/database\")\n  if err != nil {\n    // handle err\n  }\n\n  store, err := postgres.NewStore(db, []byte(\"secret\"))\n  if err != nil {\n    // handle err\n  }\n\n  r.Use(sessions.Sessions(\"mysession\", store))\n\n  r.GET(\"/incr\", func(c *gin.Context) {\n    session := sessions.Default(c)\n    var count int\n    v := session.Get(\"count\")\n    if v == nil {\n      count = 0\n    } else {\n      count = v.(int)\n      count++\n    }\n    session.Set(\"count\", count)\n    session.Save()\n    c.JSON(200, gin.H{\"count\": count})\n  })\n  r.Run(\":8000\")\n}\n```\n","funding_links":[],"categories":["Go","Middlewares"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgin-contrib%2Fsessions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgin-contrib%2Fsessions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgin-contrib%2Fsessions/lists"}