(Deprecated) Budibase Docs
  • 👋Introduction
  • Quickstart tutorials
    • Build a CRUD app
      • Importing the Vehicles table from a CSV
      • Creating the Service log table from scratch
      • Listing recent Service Logs on the home screen
      • Creating a new Service Log with a modal
    • Build a CRUD app- SQL
      • Connecting to your SQL tables
      • Creating Screens from your SQL tables
      • Using relationships between SQL tables
      • Creating a List screen from scratch, using a SQL table
      • Creating a new log, with a modal
    • Build a CRUD app - REST
      • Adding a REST datasource
      • Creating a query that Lists Issues
      • Using your request to display items in your app
      • Add a “Create Item” request
      • Create a new todo Item, inline
      • Mark todo items as “Done”
      • Finishing Touches
  • Building apps
    • Data
      • Users table
      • Data sources
        • Internal/CSV
        • PostgreSQL and MySQL
        • REST
          • REST Queries
          • REST Bindings Example
          • REST Query Import
          • REST Authentication
          • REST Variables
        • Other sources
      • Data Types
        • Text
        • Number
        • True/False (Boolean)
        • Date/time
        • Options
        • Attachments
          • Example
        • Relationships
          • Example
        • Formula
        • JSON
      • Views
        • Filters
        • Calculations
        • Groups
      • Transformers
    • Design
      • Screens
      • Layouts
      • Components
        • Section
        • Container
        • Data Provider
        • Repeater
        • Table
        • Chart
        • Card
        • Text
        • Button
        • Link
        • Icon
        • Image
        • Embed
      • Forms
        • Form Component
        • Field Groups
        • Fields
      • Bindings
      • Actions
      • App State
      • Conditions
      • App theming (coming soon)
      • Handling Data
        • Search/Filter Data
    • Automate
      • Automation steps
        • Triggers
        • Logic
        • Actions
      • Activating and testing
      • Contextual bindings
    • Admin and management
      • User Management
      • Authentication and SSO
        • OpenID Connect
        • SSO with Auth0
        • SSO with Azure AD
        • SSO with Okta
        • SSO with OneLogin
        • SSO with Google
        • SSO with Keycloak
      • Email
      • Portal
      • User Settings
  • Guides
    • Display user-related data
    • Add search
    • Add filtering
    • Create public & private screens
    • Writing a custom SQL query
    • Create a child record from the parent
    • Items assigned to me
    • Master-detail
  • Self-hosting
    • Get started
      • Budibase CLI Setup
    • Hosting methods
      • Overview
      • DigitalOcean
      • Kubernetes (K8S)
      • Docker compose
    • Hosting settings
      • Advanced options
        • Reverse proxy
    • Accessing CouchDB
    • Accessing MinIO
  • References
    • Budibase architecture
    • Deployment information
    • Troubleshooting
    • Contributing to Budibase
      • Writing Your Own External Data Connectors
Powered by GitBook
On this page
  • Downloading Budibase CLI
  • Running Budibase
  • First Time Budibase Setup
Export as PDF
  1. Self-hosting
  2. Get started

Budibase CLI Setup

Downloading Budibase CLI

The budibase CLI is how you initialise, manage and update your budibase installation.

Downloading the Budibase CLI is a fairly straight forward process. If you have NodeJS installed, you can simply run the following to install the budibase CLI:

$ npm i -g @budibase/cli

Alternatively, you can just download the budibase CLI for your operating system here:

  • Windows

  • Mac

  • Linux

If you do download from the above links, the steps are slightly different compared to downloading the CLI from NPM. After downloading the CLI, you will have to make it executable. Let's take the cli-linux for example:

# optional - if you have already downloaded this just navigate to the file
wget https://github.com/Budibase/budibase/releases/latest/download/cli-linux

chmod +x cli-linux

# optional - rename to budi
mv cli-linux budi

When following the rest of this guide, when you see the budi command being used, you will need to replace it with:

./budi

Running Budibase

Once the CLI is installed, navigate to the directory where you would like to store the files for your budibase installation, and run:

budi hosting --init # or ./cli-linux hosting --init
? This will create multiple files in current directory, should continue? Yes

# Feel free to configure your port
? Please enter the port on which you want your installation to run:  10000

Configuration has been written successfully - please check .env file for more details.

If you have an ARM based CPU, you will have to make a slight update to your docker-compose.yaml . Update the couchdb-service part of your compose config with platform: amd64

 couchdb-service:
    platform: linux/amd64
    ...

First Time Budibase Setup

You can now start the budibase services with the following command.

budi hosting --start
Starting services, this may take a moment.
Services started, please go to http://localhost:10000 for next steps.
PreviousGet startedNextHosting methods

Last updated 3 years ago