{"id":34221916,"url":"https://github.com/b4m-oss/orgboss","last_synced_at":"2026-01-23T22:33:07.799Z","repository":{"id":332416612,"uuid":"1112177858","full_name":"b4m-oss/orgboss","owner":"b4m-oss","description":"Organization multi-tenant management package with authboss","archived":false,"fork":false,"pushed_at":"2025-12-08T12:10:50.000Z","size":118,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-01-13T20:37:36.898Z","etag":null,"topics":["authorization","go","golang","golang-module","organization-management"],"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/b4m-oss.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-12-08T09:03:18.000Z","updated_at":"2025-12-08T12:39:02.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/b4m-oss/orgboss","commit_stats":null,"previous_names":["b4m-oss/orgboss"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/b4m-oss/orgboss","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/b4m-oss%2Forgboss","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/b4m-oss%2Forgboss/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/b4m-oss%2Forgboss/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/b4m-oss%2Forgboss/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/b4m-oss","download_url":"https://codeload.github.com/b4m-oss/orgboss/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/b4m-oss%2Forgboss/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28701676,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-23T17:25:48.045Z","status":"ssl_error","status_checked_at":"2026-01-23T17:25:47.153Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["authorization","go","golang","golang-module","organization-management"],"created_at":"2025-12-15T23:26:02.925Z","updated_at":"2026-01-23T22:33:07.793Z","avatar_url":"https://github.com/b4m-oss.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# orgboss\n\nOrganization multi-tenant management package with authboss\n\n[![Tests](https://github.com/b4m-oss/orgboss/actions/workflows/test.yml/badge.svg)](https://github.com/b4m-oss/orgboss/actions/workflows/test.yml)\n\n## Features\n\n- **Organization and User Management**: Create organizations and users atomically with transaction support\n- **Invitation System**: Invite users to organizations via email with token-based authentication and expiry management\n- **Role-Based Access Control**: Manager and user roles with different permissions (manager: full access, user: read-only)\n- **Customizable Handlers**: Implement custom logic via `RoleChecker`, `DeletionHandler`, and `EmailSender` interfaces\n- **Hook System**: Extensible hooks for before/after operations (organization creation, user deletion, etc.)\n- **Authboss Integration**: Seamless integration with [Authboss](https://github.com/aarondl/authboss) authentication package\n- **Storage Flexibility**: In-memory storage for testing, PostgreSQL storage for production via GORM\n\n## Requirements\n\n- Go 1.24 or higher\n- PostgreSQL (for production use)\n- SMTP server (for email invitations)\n\n## Installation\n\n```bash\ngo get github.com/b4m-oss/orgboss\n```\n\n## Quick Start\n\n```go\npackage main\n\nimport (\n    \"context\"\n    \"github.com/b4m-oss/orgboss\"\n)\n\nfunc main() {\n    ctx := context.Background()\n    \n    // Create a manager with default configuration\n    manager := orgboss.NewManager(nil)\n    \n    // Create an organization with the first user (automatically assigned manager role)\n    org, user, err := manager.CreateOrganizationWithUser(\n        ctx,\n        \"My Organization\",\n        \"manager@example.com\",\n    )\n    if err != nil {\n        panic(err)\n    }\n    \n    // The user is automatically assigned the manager role\n    // org.ID and user.ID are now available\n}\n```\n\n## Configuration\n\nUse `Config` to customize orgboss behavior:\n\n```go\nimport \"time\"\n\nconfig := \u0026orgboss.Config{\n    InvitationExpiryDuration:        24 * time.Hour,\n    DefaultRole:                     orgboss.RoleUser,\n    EnableBulkInvite:                true,\n    MaxBulkInviteCount:              100,\n    InvitationBaseURL:               \"http://localhost:8080\",\n    InvitationRedirectPath:          \"/reset-password\",\n    EnableAutoLoginAfterPasswordReset: true,\n}\n\nmanager := orgboss.NewManager(config)\n```\n\n### Configuration Options\n\n- `InvitationExpiryDuration`: Duration before invitations expire (default: 24 hours)\n- `DefaultRole`: Default role for new users (default: `RoleUser`)\n- `EnableBulkInvite`: Enable bulk invitation feature (default: `true`)\n- `MaxBulkInviteCount`: Maximum number of invitations per bulk operation (default: 100)\n- `InvitationBaseURL`: Base URL for invitation links (required for email invitations)\n- `InvitationRedirectPath`: Redirect path after invitation acceptance (default: `/reset-password`)\n- `EnableAutoLoginAfterPasswordReset`: Enable auto-login after password reset (default: `true`)\n\n## Storage\n\nBy default, orgboss uses an in-memory storage implementation suitable for testing. For production use, implement the `Storage` interface and use `NewManagerWithStorage`.\n\n### Using PostgreSQL Storage\n\n```go\nimport (\n    \"github.com/b4m-oss/orgboss/internal/database\"\n    \"github.com/b4m-oss/orgboss/internal/storage\"\n)\n\n// Connect to PostgreSQL\ndb, err := database.Connect()\nif err != nil {\n    panic(err)\n}\n\n// Run migrations\nerr = database.Migrate(db)\nif err != nil {\n    panic(err)\n}\n\n// Create PostgreSQL storage\npostgresStorage := storage.NewPostgresStorage(db)\n\n// Create manager with PostgreSQL storage\nconfig := orgboss.DefaultConfig()\nconfig.EmailSender = email.NewSMTPEmailSender() // Required for invitations\nmanager := orgboss.NewManagerWithStorage(config, postgresStorage)\n```\n\n## Examples\n\n### Inviting Users\n\n```go\n// Invite a single user\ninvitation, err := manager.InviteUser(ctx, org.ID, \"user@example.com\")\nif err != nil {\n    panic(err)\n}\n\n// Bulk invite multiple users\nemails := []string{\"user1@example.com\", \"user2@example.com\", \"user3@example.com\"}\ninvitations, err := manager.InviteUsers(ctx, org.ID, emails)\nif err != nil {\n    panic(err)\n}\n```\n\n### Accepting Invitations\n\n```go\n// Accept an invitation (creates user with random password)\nuser, err := manager.AcceptInvitation(ctx, invitation.Token)\nif err != nil {\n    panic(err)\n}\n\n// Update password (invitation status becomes accepted)\nerr = manager.UpdatePassword(ctx, user.ID, org.ID, \"newpassword123\")\nif err != nil {\n    panic(err)\n}\n```\n\n### Permission Checking\n\n```go\n// Check if user has permission to perform an action\nerr := manager.CheckPermission(ctx, userID, orgID, \"update\")\nif err != nil {\n    // Permission denied\n}\n\n// Validate organization access\nerr := manager.ValidateOrganizationAccess(ctx, userID, orgID)\nif err != nil {\n    // Access denied\n}\n```\n\n## Customization\n\n### Custom RoleChecker\n\n```go\ntype CustomRoleChecker struct{}\n\nfunc (c *CustomRoleChecker) HasPermission(role orgboss.Role, action string) bool {\n    switch role {\n    case orgboss.RoleManager:\n        return true\n    case orgboss.RoleUser:\n        return action == \"read\" || action == \"update\"\n    default:\n        return false\n    }\n}\n\nconfig := orgboss.DefaultConfig()\nconfig.RoleChecker = \u0026CustomRoleChecker{}\nmanager := orgboss.NewManager(config)\n```\n\n### Custom DeletionHandler\n\n```go\ntype CustomDeletionHandler struct {\n    storage orgboss.Storage\n}\n\nfunc (h *CustomDeletionHandler) DeleteUser(ctx context.Context, user *orgboss.User) error {\n    // Implement custom deletion logic (e.g., email masking, anonymization)\n    user.Email = \"deleted@example.com\"\n    return h.storage.UpdateUser(ctx, user)\n}\n\nfunc (h *CustomDeletionHandler) DeleteOrganization(ctx context.Context, org *orgboss.Organization) error {\n    // Implement custom organization deletion logic\n    return h.storage.DeleteOrganization(ctx, org.ID)\n}\n\nfunc (h *CustomDeletionHandler) SetStorage(storage orgboss.Storage) {\n    h.storage = storage\n}\n\nconfig := orgboss.DefaultConfig()\nconfig.DeletionHandler = \u0026CustomDeletionHandler{}\nmanager := orgboss.NewManager(config)\n```\n\n### Custom EmailSender\n\n```go\nimport \"github.com/b4m-oss/orgboss/internal/email\"\n\n// Use built-in SMTP email sender\nsmtpSender := email.NewSMTPEmailSender()\n// Configure via environment variables:\n// SMTP_HOST=localhost\n// SMTP_PORT=1025\n// SMTP_FROM=noreply@example.com\n\nconfig := orgboss.DefaultConfig()\nconfig.EmailSender = smtpSender\nconfig.InvitationBaseURL = \"http://localhost:8080\"\nmanager := orgboss.NewManager(config)\n```\n\n### Using Hooks\n\n```go\nmanager := orgboss.NewManager(nil)\n\n// Register hook before organization creation\nmanager.Hooks().BeforeOrganizationCreate = func(ctx context.Context, data interface{}) error {\n    // Custom logic before organization creation\n    return nil\n}\n\n// Register hook after organization creation\nmanager.Hooks().AfterOrganizationCreate = func(ctx context.Context, data interface{}) error {\n    org := data.(*orgboss.Organization)\n    // Custom logic after organization creation\n    return nil\n}\n```\n\n## Authboss Integration\n\norgboss integrates seamlessly with [Authboss v3](https://github.com/aarondl/authboss) for authentication.\n\n### Setup\n\n```go\nimport (\n    \"github.com/aarondl/authboss/v3\"\n    authbossuser \"github.com/b4m-oss/orgboss/internal/authboss\"\n    \"gorm.io/gorm\"\n)\n\n// Setup Authboss with orgboss integration\nab := \u0026authboss.Authboss{}\nerr := authbossuser.SetupAuthboss(db, ab)\nif err != nil {\n    panic(err)\n}\n\n// Enable auto-login after password reset\nerr = authbossuser.SetupAuthbossWithAutoLogin(db, ab, true)\nif err != nil {\n    panic(err)\n}\n```\n\n### User Model Extension\n\norgboss extends Authboss's User model with `organization_id` and `role` fields. The `authbossuser.User` struct implements Authboss's User interface.\n\n## Development\n\n### Prerequisites\n\n- Go 1.24 or higher\n- Docker and Docker Compose\n- PostgreSQL (via Docker Compose)\n\n### Running Tests\n\n```bash\n# Run unit tests\nmake test\n\n# Run integration tests (requires Docker)\nmake test-integration\n\n# Run tests with coverage\nmake test COV=TRUE\n```\n\n### Development Environment\n\n```bash\n# Start development environment (PostgreSQL, Mailpit)\nmake up\n\n# Run database migrations\nmake migrate\n\n# Stop development environment\nmake down\n```\n\n### Available Make Commands\n\n- `make up` - Start development environment\n- `make down` - Stop development environment\n- `make test` - Run unit tests\n- `make test-integration` - Run integration tests\n- `make fmt` - Format code\n- `make tidy` - Tidy dependencies\n- `make migrate` - Run database migrations\n\n## Version\n\nCurrent version: **0.2.0**\n\n## CAUTION: NEVER USE ON PRODUCTION\n\nThis module is not stable.\n\n## LICENSE\n\nMIT License - see [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fb4m-oss%2Forgboss","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fb4m-oss%2Forgboss","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fb4m-oss%2Forgboss/lists"}