Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 0 additions & 2 deletions content/docs/apps/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Mobile Apps
description: Open-source mobile apps built on Fleetbase — the Navigator App for drivers and the Storefront App for customers.
---

# Mobile Apps

Fleetbase provides two fully functional, open-source mobile applications built with React Native (Expo). These apps are designed to work seamlessly with the Fleetbase API and can be customized, white-labeled, and deployed to the App Store and Google Play Store under your own brand.

## The Navigator App
Expand Down
2 changes: 0 additions & 2 deletions content/docs/apps/navigator-app/customization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Customization & White-Labeling
description: Customize the Navigator App with your branding, colors, and features before publishing to app stores.
---

# Customization & White-Labeling

Once you have the Navigator App running locally, you can customize it to match your company's branding before deploying it to the App Store or Google Play Store.

## App Configuration (`app.json`)
Expand Down
2 changes: 0 additions & 2 deletions content/docs/apps/navigator-app/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Navigator App
description: The Navigator App is an open-source driver app for managing orders, tracking location, and communicating with dispatch.
---

# Navigator App

The Navigator App is an open-source driver app for managing orders, tracking location, and communicating with dispatch.

> This page is coming soon. Content is actively being developed.
2 changes: 0 additions & 2 deletions content/docs/apps/navigator-app/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Overview
description: An overview of the Navigator App — features, supported platforms, and how it integrates with FleetOps.
---

# Navigator App Overview

The **Navigator App** is an open-source, React Native (Expo) mobile application designed for drivers and delivery personnel. It integrates directly with the [FleetOps](/docs/fleetops/overview) extension to provide a complete end-to-end delivery management solution.

## Key Features
Expand Down
2 changes: 0 additions & 2 deletions content/docs/apps/navigator-app/setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Setup & Configuration
description: Set up the Navigator App, configure it to connect to your Fleetbase instance, and prepare it for deployment.
---

# Setup & Configuration

This guide explains how to set up the Navigator App locally, configure it to connect to your Fleetbase instance, and prepare it for deployment.

## Prerequisites
Expand Down
2 changes: 0 additions & 2 deletions content/docs/apps/storefront-app/customization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Customization & White-Labeling
description: Customize the Storefront App with your branding and product catalog before publishing to app stores.
---

# Customization & White-Labeling

Once you have the Storefront App running locally, you can customize it to match your company's branding before deploying it to the App Store or Google Play Store.

## App Configuration (`app.json`)
Expand Down
2 changes: 0 additions & 2 deletions content/docs/apps/storefront-app/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Storefront App
description: The Storefront App is an open-source customer-facing mobile app for your Storefront-powered marketplace.
---

# Storefront App

The Storefront App is an open-source customer-facing mobile app for your Storefront-powered marketplace.

> This page is coming soon. Content is actively being developed.
2 changes: 0 additions & 2 deletions content/docs/apps/storefront-app/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Overview
description: An overview of the Storefront App — features, supported platforms, and how it integrates with the Storefront extension.
---

# Storefront App Overview

The **Storefront App** is an open-source, React Native (Expo) mobile application designed for customers. It integrates directly with the [Storefront](/docs/storefront/overview) extension to provide a complete, white-label e-commerce and on-demand delivery experience.

## Key Features
Expand Down
2 changes: 0 additions & 2 deletions content/docs/apps/storefront-app/setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Setup & Configuration
description: Set up the Storefront App and connect it to your Fleetbase Storefront instance.
---

# Setup & Configuration

This guide explains how to set up the Storefront App locally, configure it to connect to your Fleetbase instance, and prepare it for deployment.

## Prerequisites
Expand Down
2 changes: 0 additions & 2 deletions content/docs/cli/account/generate-token.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Generate Token
description: "Generate or regenerate a long-lived registry authentication token using `flb generate-token` — ideal for CI/CD pipelines."
---

# `flb generate-token`

Generate (or regenerate) a long-lived **registry authentication token** for your developer account. Tokens are great for CI/CD pipelines where you don't want to store a username and password.

```bash
Expand Down
2 changes: 0 additions & 2 deletions content/docs/cli/account/login.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Login
description: "Authenticate with the Fleetbase registry using `flb login` — under the hood this writes credentials into your `.npmrc`."
---

# `flb login`

Log in to the Fleetbase Extension Registry using your username, password, and email. Under the hood the CLI delegates to `npm-cli-login`, which writes a registry auth entry into your `~/.npmrc`.

```bash
Expand Down
2 changes: 0 additions & 2 deletions content/docs/cli/account/register.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Register
description: "Create a Fleetbase Extension Registry developer account using `flb register` so you can publish your own extensions."
---

# `flb register`

Create a developer account on the Fleetbase Extension Registry. You need an account to publish extensions — managing or installing extensions does **not** require an account.

```bash
Expand Down
2 changes: 0 additions & 2 deletions content/docs/cli/account/resend-verification.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Resend Verification
description: "Request a fresh verification code from the registry using `flb resend-verification`."
---

# `flb resend-verification`

Request that the registry email a fresh verification code. Use this when the original email from `flb register` never arrived, or when the code has expired.

```bash
Expand Down
2 changes: 0 additions & 2 deletions content/docs/cli/account/set-auth.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Set Auth
description: "Write a registry auth token into your Fleetbase instance's `.npmrc` and Composer `auth.json` using `flb set-auth`."
---

# `flb set-auth`

Write a registry auth token into your Fleetbase instance's `console/.npmrc` (for npm) and `api/auth.json` (for Composer). Run this after [`flb verify`](/docs/cli/account/verify) or [`flb generate-token`](/docs/cli/account/generate-token) returns a token.

```bash
Expand Down
2 changes: 0 additions & 2 deletions content/docs/cli/account/verify.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Verify
description: "Verify your registry account email using `flb verify` and receive your registry auth token."
---

# `flb verify`

Verify the email on a registry account you just registered. On success, the registry returns your **registry auth token** — save it; you'll use it to publish extensions.

```bash
Expand Down
2 changes: 0 additions & 2 deletions content/docs/cli/extension-development/bundle-upload.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Bundle Upload
description: "Upload an existing extension bundle to the Fleetbase registry using `flb bundle-upload`."
---

# `flb bundle-upload`

Upload a `.tar.gz` bundle (created by [`flb bundle`](/docs/cli/extension-development/bundle)) to the Fleetbase Extension Registry. Use this when you've already bundled (e.g. as a separate CI step) and just need to ship the archive.

```bash
Expand Down
2 changes: 0 additions & 2 deletions content/docs/cli/extension-development/bundle.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Bundle
description: "Pack an extension into a versioned `.tar.gz` for distribution using `flb bundle`."
---

# `flb bundle`

Package your extension into a `.tar.gz` archive for distribution. The output is named `<package-name>-v<version>-bundle.tar.gz` and excludes `node_modules/`, `server_vendor/`, and any previously generated bundle files.

```bash
Expand Down
2 changes: 0 additions & 2 deletions content/docs/cli/extension-development/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Overview
description: Build, test, version, bundle, and publish custom Fleetbase extensions using the CLI.
---

# Publishing Extensions

The CLI gives you the full lifecycle for authoring and shipping a Fleetbase extension — from scaffolding a new project to publishing it on the Extension Registry.

## The Lifecycle
Expand Down
2 changes: 0 additions & 2 deletions content/docs/cli/extension-development/publish.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Publish
description: "Publish your extension to the Fleetbase Extension Registry using `flb publish` — runs `npm publish` against the configured registry."
---

# `flb publish`

Publish your extension to the Fleetbase Extension Registry. Under the hood this runs `npm publish` against the registry. Both an npm package (`package.json`) and a Composer package (`composer.json`) are typically published — but `flb publish` handles them via the same npm publish mechanism (the CLI auto-converts `composer.json` into a temporary `package.json` for the API side).

```bash
Expand Down
2 changes: 0 additions & 2 deletions content/docs/cli/extension-development/scaffold.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Scaffold
description: "Generate a new Fleetbase extension from the starter template using `flb scaffold`."
---

# `flb scaffold`

Generate a new Fleetbase extension from the [`fleetbase/starter-extension`](https://github.com/fleetbase/starter-extension) template. The CLI clones the template, prompts for your extension's name and metadata, then refactors namespaces, package names, and class names so it's ready to develop against immediately.

```bash
Expand Down
2 changes: 0 additions & 2 deletions content/docs/cli/extension-development/unpublish.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Unpublish
description: "Remove a published extension from the Fleetbase Extension Registry using `flb unpublish`."
---

# `flb unpublish`

Remove a published extension (or a specific version of it) from the registry. Under the hood this runs `npm unpublish --force`.

```bash
Expand Down
2 changes: 0 additions & 2 deletions content/docs/cli/extension-development/version-bump.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Version Bump
description: "Increment the version of your extension across all manifest files using `flb version-bump`."
---

# `flb version-bump`

Bump your extension's version across **all three manifest files** in one step:

- `extension.json`
Expand Down
2 changes: 0 additions & 2 deletions content/docs/cli/extensions/install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Install
description: "Install an extension into a running Fleetbase instance using `flb install`."
---

# `flb install`

Install a Fleetbase extension into a running self-hosted Fleetbase instance. The CLI looks up the npm and Composer package names for the extension and runs both `pnpm install` (in `console/`) and `composer require` (in `api/`).

```bash
Expand Down
2 changes: 0 additions & 2 deletions content/docs/cli/extensions/search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Search
description: "Browse the Fleetbase Extension Registry from the command line with `flb search`."
---

# `flb search`

Browse and filter the Fleetbase Extension Registry from your terminal. Use this to discover available extensions before installing one.

```bash
Expand Down
2 changes: 0 additions & 2 deletions content/docs/cli/extensions/uninstall.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Uninstall
description: "Remove an installed extension from a running Fleetbase instance using `flb uninstall`."
---

# `flb uninstall`

Remove a previously installed extension from a Fleetbase instance. The CLI runs `pnpm remove` (in `console/`) and `composer remove` (in `api/`).

```bash
Expand Down
2 changes: 0 additions & 2 deletions content/docs/cli/getting-started/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Commands
description: Reference table of every Fleetbase CLI command with a one-line description and a link to its page.
---

# Commands

Quick reference for every command the `flb` CLI exposes. Click any command for the full options, examples, and behavior.

## Install Fleetbase
Expand Down
2 changes: 0 additions & 2 deletions content/docs/cli/getting-started/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Installing the CLI
description: Install the Fleetbase CLI globally via npm so the `flb` command is available system-wide.
---

# Installing the CLI

The Fleetbase CLI is distributed on npm as `@fleetbase/cli`. Install it globally so the `flb` command is on your PATH.

## With npm
Expand Down
2 changes: 0 additions & 2 deletions content/docs/cli/getting-started/requirements.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Requirements
description: What you need installed before using the Fleetbase CLI — Node, plus Docker and Git for installing Fleetbase itself.
---

# Requirements

The CLI itself runs on Node. Some commands additionally need Docker, Git, pnpm, or PHP/Composer on your machine.

## CLI Itself
Expand Down
2 changes: 0 additions & 2 deletions content/docs/cli/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Fleetbase CLI
description: The Fleetbase CLI (flb) — install Fleetbase, manage extensions on a running instance, and publish your own extensions to the registry.
---

# Fleetbase CLI

The **Fleetbase CLI** (`flb`) is the official command-line tool for working with Fleetbase. It does three things:

- **Installs Fleetbase** on your own infrastructure with an interactive Docker-based setup wizard
Expand Down
2 changes: 0 additions & 2 deletions content/docs/cli/installation/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Install Fleetbase
description: "Install a self-hosted Fleetbase instance on your own infrastructure using `flb install-fleetbase` — an interactive Docker-based wizard."
---

# Install Fleetbase

```bash
flb install-fleetbase
```
Expand Down
2 changes: 0 additions & 2 deletions content/docs/community/changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Changelog
description: Release notes and version history across the Fleetbase platform — core API, Console, extensions, and mobile apps.
---

# Changelog

Fleetbase is a modular platform composed of several independent repositories, each with its own release cycle. Release notes are maintained on GitHub Releases for each repository.

## Platform Releases
Expand Down
2 changes: 0 additions & 2 deletions content/docs/community/discord.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Discord Community
description: Join the Fleetbase Discord server to get help, share what you've built, and connect with the core team and other operators.
---

# Discord Community

The Fleetbase Discord server is the fastest way to get help, share what you're building, and connect with the core team and other operators running Fleetbase in production.

**[Join the Fleetbase Discord →](https://discord.com/invite/V7RVWRQ2Wm)**
Expand Down
2 changes: 0 additions & 2 deletions content/docs/community/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: FAQ
description: Answers to frequently asked questions about Fleetbase — what it is, how it's licensed, how to deploy it, and how it works.
---

# Frequently Asked Questions

<Accordions>
<Accordion title="What is Fleetbase?">
Fleetbase is an open-source, modular logistics and supply chain operating system. It provides a platform for managing fleets, orders, drivers, warehouses, and supply chain operations — either self-hosted on your own infrastructure or via Fleetbase Cloud.
Expand Down
2 changes: 0 additions & 2 deletions content/docs/community/github-discussions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: GitHub Discussions
description: Ask questions, propose features, and participate in longer-form community conversations about Fleetbase on GitHub Discussions.
---

# GitHub Discussions

[GitHub Discussions](https://github.com/fleetbase/fleetbase/discussions) is the home for longer-form community conversations about Fleetbase — feature proposals, architecture questions, integration ideas, and anything that benefits from a permanent, searchable record rather than a real-time chat message.

**[Open a Discussion →](https://github.com/fleetbase/fleetbase/discussions/new/choose)**
Expand Down
2 changes: 0 additions & 2 deletions content/docs/community/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Community & Support
description: Get help, contribute to Fleetbase, and find the right support option for your team.
---

# Community & Support

Fleetbase is open-source and community-driven. Whether you need help getting started, want to report a bug, contribute code, or talk through a deployment with the core team — this is where to start.

## Real-Time Help
Expand Down
2 changes: 0 additions & 2 deletions content/docs/community/licensing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Licensing
description: Understand the Fleetbase licensing model — AGPL-3.0 for open-source use and commercial license options for proprietary products.
---

# Licensing

Fleetbase uses a **dual-licensing model**: an open-source license for the community and a commercial license for proprietary use cases.

<Callout type="info">
Expand Down
2 changes: 0 additions & 2 deletions content/docs/community/support-plans.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Support Plans
description: Community, cloud, and enterprise support options for Fleetbase — from free community channels to dedicated SLAs.
---

# Support Plans

Fleetbase offers several support options depending on whether you're self-hosting, on Fleetbase Cloud, or need enterprise-grade guarantees.

## Community Support — Free
Expand Down
2 changes: 0 additions & 2 deletions content/docs/contributing/code.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ description: How to submit bug fixes, features, and refactors to Fleetbase — b
sidebarTitle: Code
---

# Code contributions

This page covers contributing **code** to Fleetbase — bug fixes, features, refactors, and improvements across the core platform and its extensions.

For other contribution types see [Translations](/docs/contributing/translations), [Documentation](/docs/contributing/documentation), [Extensions](/docs/contributing/extensions), or [Reporting issues](/docs/contributing/reporting-issues).
Expand Down
2 changes: 0 additions & 2 deletions content/docs/contributing/documentation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ description: How to contribute to Fleetbase documentation — fixing typos, addi
sidebarTitle: Documentation
---

# Documentation contributions

The documentation you're reading right now lives in the [`fleetbase/fleetbase.io`](https://github.com/fleetbase/fleetbase.io) repository. Every page is editable. If something is wrong, unclear, or missing — submit a PR.

## Where the docs live
Expand Down
2 changes: 0 additions & 2 deletions content/docs/contributing/extensions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ description: How to build, publish, and contribute extensions for the Fleetbase
sidebarTitle: Extensions
---

# Extension contributions

The biggest single way to contribute to Fleetbase is building an **extension** — a packaged module that other operators can install from the marketplace.

Extensions can:
Expand Down
2 changes: 0 additions & 2 deletions content/docs/contributing/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Contributing to Fleetbase
description: How to contribute to Fleetbase — bug reports, code, documentation, translations, and extensions. Every contribution helps the platform grow.
---

# Contributing to Fleetbase

Fleetbase is open-source under AGPL-3.0 and shaped by the people who use it. Every contribution — a typo fix, a translation, a bug report, an extension — helps the platform grow.

This section walks through every way to contribute, broken down by area so you can find the path that fits.
Expand Down
2 changes: 0 additions & 2 deletions content/docs/contributing/reporting-issues.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ description: How to file effective bug reports and feature requests for Fleetbas
sidebarTitle: Reporting issues
---

# Reporting issues

A good bug report makes the difference between a fix in days and a fix in months. This page covers how to file one well, where to file it, and what to expect after.

## Bug reports
Expand Down
2 changes: 0 additions & 2 deletions content/docs/contributing/translations/file-format.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ description: YAML structure, placeholder syntax, pluralization, and translation
sidebarTitle: File format
---

# File format

Translation files are **YAML**. This page covers the structure, what to translate (and what to leave alone), and the conventions that keep translations consistent across locales.

## Anatomy of a locale file
Expand Down
2 changes: 0 additions & 2 deletions content/docs/contributing/translations/glossary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ description: Brand names, technical terms, and domain vocabulary that should —
sidebarTitle: Glossary
---

# Translation glossary

A reference for terms that come up repeatedly in Fleetbase translations. The default rule: translate everything that has a clear local equivalent. The exceptions below are documented because they tend to cause confusion.

## Brand names — never translate
Expand Down
Loading