Welcome to Pegasus’s documentation!

Here you’ll find everything you need to know about setting up and configuring Pegasus for your project.

You’ll need a Pegasus license to proceed. If you don’t have one, head on over to saaspegasus.com to get yours.

If you’re just getting started, you’ll want to start with the Getting Started guide.

The source for this documentation can be found on Github and contributions are most welcome!

All Documentation:

• Getting Started
  • Watch the video
  • Create and download your project codebase
  • Set up source control
  • Get up and running with Docker
  • Get up and running with native Python
  • Post-installation steps
  • Building Your Application
• Customizations
  • Personalize your landing page
  • Update the logged-in experience
  • Python Packages
  • Styles
  • Javascript
• Settings and Configuration
  • Project Metadata
  • Absolute URLs
  • Sending Email
  • User Sign Up
  • Stripe
  • Google Analytics
  • Sentry
  • Celery
  • Mailing List
  • Logging
  • Storing media files
• Pegasus’s Code Structure
  • Overall structure
  • Your {{project_name}} module
  • Your apps module
  • The pegasus module
  • The requirements folder
  • The assets folder
  • The static folder
  • The templates folder
• Using Virtual Environments
  • Using virtualenv
  • Alternative instructions using virtualenvwrapper
• The Front End
  • Architecture
  • Front-end files
  • Prerequisites to building the front end
  • Initial setup
  • Building in Development
  • Building for production
  • Long-term best practices
  • TypeScript and type checking
• CSS
  • Choosing a CSS Theme
  • CSS File Structure
  • Pegasus CSS
  • Tailwind CSS
  • Bootstrap (and Material)
  • Bulma
• Project/Page Metadata and SEO
  • The PROJECT_METADATA setting
  • Page Titles
  • Sitemaps
• Using Docker in Development
  • Prerequisites
  • Getting Started
  • Using the Makefile
  • Architecture and how it works
  • Running once-off management commands
  • Updating Python packages
  • Debugging
  • Other Resources
• Subscriptions
  • Overview
  • Getting Started
  • Customer Portal
  • Webhooks
  • Feature-Gating
  • Per-Unit / Per-Seat Billing
  • Troubleshooting
• Using Teams
  • Example App
  • Data Models
  • Team-based Views
• Using Payments
  • Create the payments app
  • Setup Database Models
  • Setup UI
  • Success!
• APIs
  • APIs in Pegasus
  • API Documentation
  • API Clients
  • API Keys
  • Troubleshooting
• Internationalization
  • Demo
  • Localization
  • Technical notes
• Wagtail CMS
  • Video Overview
  • Pegasus and Wagtail
  • Adding Blog Posts
  • Customizing Wagtail
  • Alternatives to Wagtail
• Feature Flags
  • Usage
  • Usage with Teams
  • Example usage
• Celery
  • Quick Start
  • Setup and Configuration
• Deployment
  • Deployment Overview
  • Officially supported platforms
  • Heroku
  • Fly.io
  • Render
  • Digital Ocean
  • Google Cloud
  • Production checklist
  • Troubleshooting
• Using Github Actions
  • Running Django Tests
  • Building the Front End
• Cookbooks
  • Use the Django Admin UI
  • Delete Pegasus Examples
  • Delete Stripe Code
  • Using the Payments example
• Upgrading
  • Using branches (recommended)
  • Using patches (if you can’t use branches)
  • Other notes
• Version History and Release Notes
  • Version 2022.11.1
  • Version 2022.11
  • Version 2022.10
  • Version 2022.9
  • Version 2022.8.2
  • Version 2022.8.1
  • Version 2022.8
  • Version 2022.7.1
  • Version 2022.7
  • Version 2022.6
  • Version 2022.5
  • Version 2022.4.2
  • Version 2022.4.1
  • Version 2022.4
  • Version 2022.3
  • Version 0.22.1
  • Version 0.22
  • Version 0.21.1
  • Version 0.21
  • Version 0.20
  • Version 0.19
  • Version 0.18.1
  • Version 0.18
  • Version 0.17.1
  • Version 0.17
  • Version 0.16.2
  • Version 0.16.1
  • Version 0.16
  • Version 0.15
  • Version 0.14.5
  • Version 0.14.4
  • Version 0.14.3
  • Version 0.14.2
  • Version 0.14.1
  • Version 0.14
  • Version 0.13.2
  • Version 0.13.1
  • Version 0.13.0
  • Version 0.12.1
  • Version 0.12.0
  • Version 0.11.3
  • Version 0.11.2
  • Version 0.11.1
  • Version 0.11.0
  • Version 0.10.5
  • Version 0.10.4
  • Version 0.10.3
  • Version 0.10.2
  • Version 0.10.1
  • Version 0.10.0
  • Version 0.9.0
  • Version 0.8.3
  • Version 0.8.2
  • Version 0.8.1
  • Version 0.8.0
  • Version 0.7.4
  • Version 0.7.3
  • Version 0.7.2
  • Version 0.7.1
  • Version 0.7.0
  • Version 0.6.1
  • Version 0.6.0
  • Version 0.5.2
  • Version 0.5.1
  • Version 0.5
  • Version 0.4 and earlier