For AI agents: visit https://docs.budibase.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Budibase Docs
DocumentationRecipesAPI ReferenceChangelog
GitHub RepoCommunityContact salesSign inGet startedBudibase Docs
Documentation
GitHub RepoCommunityContact salesSign inGet started
DocumentationRecipesAPI ReferenceChangelog

Workspace management

  • Introduction to workspaces
    • Favouriting
  • Export and import workspaces
  • Workspace migrations

AI

  • Agents config
  • Messaging channels
    • Slack messaging channel
    • Microsoft Teams messaging channel
    • Discord messaging channel
  • Agent chat
  • Agent building 101
  • Agent instructions guide
  • Agent tools and permissions
  • Agent embedding models
  • Agent vector databases
  • Agent testing guide
  • Agent troubleshooting

Data

  • Introduction to data
    • Dev / Prod switcher
    • Views
    • Users table
  • Budibase DB
    • AI Column🔒
    • Attachments
    • Barcode/QR
    • Boolean (True/False)
    • Date/Time
    • JSON
    • Multi-select
    • Number
    • Relationships
    • Text
    • User
    • Options
  • Datasources
    • CouchDB
    • CSV Import
    • DynamoDB
    • Elasticsearch
    • Firestore
    • Google Sheets
    • MongoDB
    • MS SQL Server
    • MySQL / MariaDB
    • Oracle
    • PostgreSQL
    • Redis
    • S3
    • Snowflake
  • REST API
    • REST Templates
    • REST queries
    • REST bindings (tutorial)
    • REST query import
    • REST authentication
    • REST variables
    • REST pagination
    • REST OAuth2
    • REST example
  • SQL
  • Transformers
  • Environment variables 🔒
  • PDF exporting 🔒
  • AI-Powered Table Generation

Apps

  • Introduction to apps
    • App building 101
    • Command Palette
    • Update workspace version
  • Data in design
    • Displaying data
    • Data provider
    • Repeater
    • Adding filtering
    • Adding search
    • Single Row Provider
  • Design guides
    • Designing for mobile
    • Theming your app
    • Using sections
  • Screens
  • Navigation
  • Blocks
    • Form block
    • Multi-step form block
  • Components
    • Accordion
    • Attachment
    • Barcode/QR Scanner
    • Barcode/QR Generator
    • Buttons
    • Card
    • Checkbox
    • Container
    • Date range
    • Displaying text
    • Divider
    • Dynamic filter
    • Embed
    • Embedded Map
    • Icon
    • Image
    • Link
    • Rating
    • S3 File Upload
    • Side panel
    • Signature Field
    • URL Field
    • Stat Card
    • Table
    • Tag
    • Text inputs
    • Filter
    • Calendar
    • Chatbox
  • Pickers
    • Date picker
    • Multi-select picker
    • Options picker
    • Relationship picker
  • Charts
    • Area Chart
    • Bar Chart
    • Line Chart
    • Pie & Donut Chart
    • Histogram Chart
    • Candlestick Chart
  • Forms
    • Field groups
    • Form validation
    • Saving static values
    • Form bindings
  • Actions
    • Data actions
    • Application actions
    • Form actions
    • Chaining actions
  • App state
    • State explorer interface
  • Conditional UI
  • Custom CSS
  • Generating JavaScript with AI
  • App scripts 🔒
  • Progressive Web Apps 🔒
  • Link directly to Budibase app

Automation

  • Introduction to automations
    • Automation building 101
  • Triggers
    • On demand
    • Cron job
    • Webhook
    • Row triggers
    • Row trigger filters
    • Row actions
    • Email listener
  • Action steps
    • Branching
    • Condition
    • Discord
    • External Data Connector
    • JS Scripting
    • Loop
    • Make (Integromat)
    • n8n
    • Query Rows
    • Send Email
    • Slack
    • Trigger automation 🔒
    • Zapier
    • AI automation steps overview
      • Classify text
      • Translate
      • Summarise
      • Generate text
      • LLM prompt
      • Agent
      • Extract document data
  • Data in automations
    • Bindings in automations
  • History and settings
  • Synchronous automations 🔒
  • Testing

Bindings

  • Introduction to bindings
  • Using Handlebars
  • Using JavaScript
  • Formula
  • Bindings scope
  • URL variables
  • Helpers
    • Math
    • Array
    • Number
    • Url
    • String
    • Comparison
    • Object
    • Date
  • Snippets 🔒
    • Time ago snippet guide
    • Formatting currency snippet guide
  • Binding explorer panel

Settings

  • Billing and Usage
  • Tenant management
    • Finding your tenant ID
  • Managing your account
  • User management
    • Adding users
    • User roles
    • Workspace access
    • Workspace user management
    • User groups 🔒
    • SCIM provisioning 🔒
  • Authentication and SSO
    • OpenID Connect
    • SSO with Okta
    • SSO with Google
    • SSO with Auth0
    • SSO with Azure AD
    • SSO with OneLogin
    • SSO with Keycloak
    • SSO Maintenance Mode
    • Enforce SSO 🔒
  • Connections
    • APIs
  • Email
  • Portal
  • User settings
  • Analytics
  • Event reference
  • Audit logs 🔒
  • Backups 🔒
  • Branding 🔒
  • V2 reCAPTCHA 🔒
  • Translations 🔒

Develop & Scale

  • Public API
  • Multiplayer collaboration
  • Embedded app
  • Custom plugins
    • Plugins quickstart
    • Custom component
    • Component schema
    • Custom datasource
    • Datasource schema
    • Custom automation step
    • Automation schema
    • View community plugins
  • Integrating with CI/CD 🔒
  • Micro Frontend Example🔒

Self-hosting

  • getting-started
  • Install methods
    • Ansible
    • Azure App Service
    • Azure Container Instances
    • Budibase CLI Install
    • DigitalOcean
    • Docker
    • Docker compose
    • Windows Server
    • Google Cloud Run
    • Kubernetes
    • Linode
    • Podman
    • Portainer
  • Hosting settings
  • Reverse Proxy
  • Accessing CouchDB
  • Accessing MinIO
  • IPv6
  • Updating Budibase
  • Running Budibase behind company proxy
  • Moving a Budibase installation
  • Migrations

References

  • Budibase architecture
  • Budibase CLI Reference
  • Command Interface
  • Contributing to Budibase
    • Writing your own external data connector
  • Deployment information
  • Troubleshooting
  • Security
  • SQL troubleshooting
  • Network access
    • Self-hosted AI connectivity
    • Self-hosted license connectivity
    • Cloud data source access
  • Feature Flags

Getting started

  • Budibase documentation
  • Quickstart
  • Quickstart: Budibase AI
  • Guides and resources
    • Calculate field value on save
    • Cascading dropdown filters
    • Create an Audit Table
    • Filter table with options picker
    • Link two entities in one form
    • Lookup record
    • Passing bindings in URL parameters
    • Populate form fields on select
    • Create a secure public form
    • Saving in progress form
    • Scroll to top of screen
    • Show button on condition
    • Table row status
    • Update date field on change
    • Keyboard Shortcuts
  • Recent updates
Powered by 

Templates

Budibase templates are ready-to-use, fully customizable applications for key use cases. Read our guides to learn how each of these works:

  1. Change Request Management
  2. Expense Approval
  3. Risk Management

Updated 4 months ago


Introduction to workspaces