# BunShip Documentation

## Docs

- [Create API Key](https://docs.bunship.com/api-reference/api-keys/create.md): Create a new API key for the organization
- [List API Keys](https://docs.bunship.com/api-reference/api-keys/list.md): Get all API keys for the organization
- [Revoke API Key](https://docs.bunship.com/api-reference/api-keys/revoke.md): Permanently revoke an API key
- [Forgot Password](https://docs.bunship.com/api-reference/auth/forgot-password.md): Request a password reset email
- [Login](https://docs.bunship.com/api-reference/auth/login.md): Authenticate with email and password
- [Logout](https://docs.bunship.com/api-reference/auth/logout.md): Revoke the current session or all sessions
- [Refresh Token](https://docs.bunship.com/api-reference/auth/refresh.md): Exchange a refresh token for a new token pair
- [Register](https://docs.bunship.com/api-reference/auth/register.md): Create a new user account
- [Reset Password](https://docs.bunship.com/api-reference/auth/reset-password.md): Set a new password using a reset token
- [Two-Factor Authentication](https://docs.bunship.com/api-reference/auth/two-factor.md): Setup, verify, and disable TOTP-based two-factor authentication
- [Verify Email](https://docs.bunship.com/api-reference/auth/verify-email.md): Confirm an email address using the verification token
- [Authentication](https://docs.bunship.com/api-reference/authentication.md): How to authenticate with the BunShip API
- [Cancel Subscription](https://docs.bunship.com/api-reference/billing/cancel.md): Cancel the subscription at the end of the current billing period
- [Create Checkout Session](https://docs.bunship.com/api-reference/billing/create-checkout.md): Create a Stripe Checkout session to subscribe to a plan
- [Get Subscription](https://docs.bunship.com/api-reference/billing/get-subscription.md): Get the current subscription status and plan details
- [List Invoices](https://docs.bunship.com/api-reference/billing/invoices.md): Get the organization's invoice history
- [Billing Portal](https://docs.bunship.com/api-reference/billing/portal.md): Get a Stripe Customer Portal URL for self-service billing management
- [API Reference](https://docs.bunship.com/api-reference/introduction.md): Complete API documentation for BunShip
- [Accept Invitation](https://docs.bunship.com/api-reference/invitations/accept.md): Accept an organization invitation
- [Cancel Invitation](https://docs.bunship.com/api-reference/invitations/cancel.md): Cancel a pending invitation
- [List Invitations](https://docs.bunship.com/api-reference/invitations/list.md): List pending invitations for the organization
- [Send Invitation](https://docs.bunship.com/api-reference/invitations/send.md): Invite a user to join the organization
- [List Members](https://docs.bunship.com/api-reference/members/list.md): List all members of an organization
- [Remove Member](https://docs.bunship.com/api-reference/members/remove.md): Remove a member from the organization
- [Update Member Role](https://docs.bunship.com/api-reference/members/update-role.md): Change a member's role within the organization
- [Create Organization](https://docs.bunship.com/api-reference/organizations/create.md): Create a new organization
- [Delete Organization](https://docs.bunship.com/api-reference/organizations/delete.md): Delete an organization (owner only)
- [Get Organization](https://docs.bunship.com/api-reference/organizations/get.md): Get details of a specific organization
- [List Organizations](https://docs.bunship.com/api-reference/organizations/list.md): List all organizations the current user belongs to
- [Update Organization](https://docs.bunship.com/api-reference/organizations/update.md): Update organization details
- [Change Password](https://docs.bunship.com/api-reference/users/change-password.md): Change the authenticated user's password
- [Get Current User](https://docs.bunship.com/api-reference/users/get-current.md): Retrieve the authenticated user's profile
- [Sessions](https://docs.bunship.com/api-reference/users/sessions.md): List and revoke user sessions
- [Update Profile](https://docs.bunship.com/api-reference/users/update-profile.md): Update the authenticated user's profile
- [Create Webhook Endpoint](https://docs.bunship.com/api-reference/webhooks/create.md): Register a new webhook endpoint
- [Delete Webhook Endpoint](https://docs.bunship.com/api-reference/webhooks/delete.md): Delete a webhook endpoint
- [List Deliveries](https://docs.bunship.com/api-reference/webhooks/deliveries.md): Get delivery history for a webhook endpoint
- [List Webhook Endpoints](https://docs.bunship.com/api-reference/webhooks/list.md): Get all webhook endpoints for the organization
- [Send Test Event](https://docs.bunship.com/api-reference/webhooks/test.md): Send a test webhook event to verify endpoint configuration
- [Update Webhook Endpoint](https://docs.bunship.com/api-reference/webhooks/update.md): Update an existing webhook endpoint
- [Architecture](https://docs.bunship.com/concepts/architecture.md): Understanding BunShip's monorepo architecture
- [Authentication](https://docs.bunship.com/concepts/authentication.md): JWT-based auth with refresh tokens and 2FA
- [Organizations](https://docs.bunship.com/concepts/organizations.md): Multi-tenant organization system
- [Permissions](https://docs.bunship.com/concepts/permissions.md): Role-based access control (RBAC)
- [Adding Routes](https://docs.bunship.com/customization/adding-routes.md): Create new API endpoints with Elysia
- [Configuration](https://docs.bunship.com/customization/configuration.md): Customize BunShip through the config package
- [Database Schema](https://docs.bunship.com/customization/database-schema.md): Modify and extend the database
- [Email Templates](https://docs.bunship.com/customization/email-templates.md): Customize transactional emails
- [OAuth Providers](https://docs.bunship.com/customization/oauth-providers.md): Add social login providers
- [AWS](https://docs.bunship.com/deployment/aws.md): Deploy to AWS with ECS or EC2
- [Docker](https://docs.bunship.com/deployment/docker.md): Deploy with Docker and Docker Compose
- [Fly.io](https://docs.bunship.com/deployment/fly-io.md): Deploy globally with Fly.io
- [Deployment Overview](https://docs.bunship.com/deployment/overview.md): Deploy BunShip to production
- [Railway](https://docs.bunship.com/deployment/railway.md): One-click deploy to Railway
- [API Keys](https://docs.bunship.com/features/api-keys.md): Programmatic API access with scoped keys
- [Audit Logs](https://docs.bunship.com/features/audit-logs.md): Track all actions in your organization
- [Background Jobs](https://docs.bunship.com/features/background-jobs.md): Async task processing with BullMQ
- [Billing & Subscriptions](https://docs.bunship.com/features/billing.md): Stripe-powered subscription management
- [File Uploads](https://docs.bunship.com/features/file-uploads.md): S3-compatible file storage
- [Webhooks](https://docs.bunship.com/features/webhooks.md): Send real-time event notifications
- [Installation](https://docs.bunship.com/installation.md): Detailed installation and configuration guide
- [Introduction](https://docs.bunship.com/introduction.md): The fastest SaaS API boilerplate built with Bun + Elysia
- [Adding New Pages](https://docs.bunship.com/pro/adding-pages.md): How to create new pages, add them to the sidebar, and protect them with RBAC.
- [UI Components](https://docs.bunship.com/pro/components.md): Available shadcn/ui components, how to use them, and how to add more.
- [Configuration Reference](https://docs.bunship.com/pro/configuration.md): Environment variables, feature flags, and analytics setup for BunShip Pro.
- [Email Templates](https://docs.bunship.com/pro/email-templates.md): Edit, preview, and add email templates in BunShip Pro.
- [Getting Started](https://docs.bunship.com/pro/getting-started.md): Clone, install, configure, and run BunShip Pro locally.
- [BunShip Pro](https://docs.bunship.com/pro/index.md): Full-stack SaaS starter kit — what's included and how to get started.
- [Customizing the Landing Page](https://docs.bunship.com/pro/landing-page.md): Edit sections, reorder layout, and update marketing content on the BunShip Pro landing page.
- [Pre-Built Pages](https://docs.bunship.com/pro/pages.md): Complete list of all 31 pages grouped by area — auth, dashboard, organization, settings, admin, and marketing.
- [Theming & Branding](https://docs.bunship.com/pro/theming.md): Customize colors, fonts, dark mode, logos, and visual style in BunShip Pro.
- [Quickstart](https://docs.bunship.com/quickstart.md): Get BunShip running in under 5 minutes

## OpenAPI Specs

- [openapi](https://docs.bunship.com/api-reference/openapi.json)

## Optional

- [GitHub](https://github.com/mayhemds/bunship)
- [Website](https://bunship.com)