fleetbase
<div id="hero"> <p align="center" dir="auto"> <a href="https://fleetbase.io" rel="nofollow"> <img src="https://user-images.githubusercontent.com/58805033/191936702-fed04b0f-7966-4041-96d0-95e27bf98248.png" alt="Fleetbase logo" width="500" height="120" style="max-width: 100%;"> </a> </p> <p align="center" dir="auto"> <a href="https://github.com/fleetbase/fleetbase/blob/main/LICENSE.md"><img src="https://img.shields.io/github/license/fleetbase/fleetbase" alt="License"></a> <a href="https://github.com/fleetbase/fleetbase/releases"><img src="https://img.shields.io/github/v/release/fleetbase/fleetbase" alt="Latest Release"></a> <a href="https://github.com/fleetbase/fleetbase/stargazers"><img src="https://img.shields.io/github/stars/fleetbase/fleetbase?style=social" alt="GitHub Stars"></a> <a href="https://discord.gg/V7RVWRQ2Wm"><img src="https://img.shields.io/discord/699834923032248430?logo=discord&label=Discord" alt="Discord"></a> <a href="https://github.com/fleetbase/fleetbase/issues"><img src="https://img.shields.io/github/issues/fleetbase/fleetbase" alt="GitHub Issues"></a> </p> <p align="center" dir="auto"> Modular logistics and supply chain operating system <br> <a href="https://www.fleetbase.io/docs" rel="nofollow" target="_fleetbase_docs">Documentation</a> · <a href="https://www.fleetbase.io/docs/api" rel="nofollow" target="_fleetbase_api_docs">API Reference</a> · <a href="https://console.fleetbase.io" rel="nofollow" target="_fleetbase_console">Cloud Version</a> · <a href="https://tally.so/r/3NBpAW" rel="nofollow">Book a Demo</a> · <a href="https://discord.gg/V7RVWRQ2Wm" target="discord" rel="nofollow">Discord</a> </p> <hr /> </div> ## What is Fleetbase? Fleetbase is a modular logistics and supply chain operating system designed to streamline management, planning, optimization, and operational control across various sectors of the supply chain industry. <p align="center" dir="auto"> <img src="https://flb-assets.s3.ap-southeast-1.amazonaws.com/static/fleetbase_overview.png" alt="Fleetbase Console" width="1200" style="max-width: 100%;" /> </p> ## 🎯 Who Is Fleetbase For? Fleetbase is designed for organizations that need powerful logistics and supply chain management: - **E-commerce & Retail** - Manage deliveries, track orders, and optimize last-mile logistics - **Food & Beverage** - Coordinate restaurant deliveries, manage drivers, and track real-time orders - **Courier Services** - Dispatch drivers, optimize routes, and provide customer tracking - **Field Services** - Schedule technicians, manage service areas, and track job completion - **Enterprise Logistics** - Build custom supply chain solutions with full API access - **Developers** - Extend and customize with a modular architecture and comprehensive API ## Visual Feature Showcase | Feature | Screenshot | Description | |---------|------------|-------------| | **Order Board** | <img src="https://flb-assets.s3.ap-southeast-1.amazonaws.com/static/order-board-kanban.png" alt="Fleetbase Order Board" width="600" /> | Visualize and manage your orders with a dynamic Kanban board. | | **Order Config** | <img src="https://flb-assets.s3.ap-southeast-1.amazonaws.com/static/order-workflow-config.png" alt="Fleetbase Order Configuration" width="600" /> | Create custom order configurations with logic, rules, automation, activity flows, and custom fields. | | **Order Tracking** | <img src="https://flb-assets.s3.ap-southeast-1.amazonaws.com/static/order-map-view.png" alt="Fleetbase Order Map View" width="600" /> | Track individual orders in real-time on an interactive map. | | **Live Fleet Map** | <img src="https://flb-assets.s3.ap-southeast-1.amazonaws.com/static/live-map-tracking.png" alt="Fleetbase Live Map Tracking" width="600" /> | Get a complete overview of your fleet and active orders on a live map. | | **Service Zones** | <img src="https://flb-assets.s3.ap-southeast-1.amazonaws.com/static/fleet-map-zones.png" alt="Fleetbase Fleet Map with Zones" width="600" /> | Define and manage service areas and zones for your fleet. | **Quickstart** ```bash npm install -g @fleetbase/cli flb install-fleetbase ``` ## 📖 Table of contents - [Features](#-features) - [Install](#-install) - [Extensions](#-extensions) - [Apps](#-apps) - [Roadmap](#-roadmap) - [Deployment Options](#-deployment-options) - [Bugs and Feature Requests](#-bugs-and--feature-requests) - [Documentation](#-documentation) - [Contributing](#-contributing) - [Community](#-community) - [Creators](#creators) - [License & Copyright](#license--copyright) ## 📦 Features | Feature | Description | |---------|-------------| | 🔌 **Extensible** | Build installable extensions and additional functionality directly into the OS via modular architecture. | | 👨💻 **Developer Friendly** | RESTful API, socket, and webhooks to seamlessly integrate with external systems or develop custom applications. | | 📱 **Native Apps** | Collection of open-source and native apps designed for operations and customer facing. | | 🤝 **Collaboration** | Dedicated chat and comments system for collaboration across your organization. | | 🔒 **Security** | Secure data encryption, adherence to industry-standard security practices, and a comprehensive dynamic Identity and Access Management (IAM) system. | | 📡 **Telematics** | Integrate and connect to hardware devices and sensors to provide more feedback and visibility into operations. | | 🌐 **Internationalized** | Translate into multiple languages to accommodate diverse user bases and global operations. | | ⚙️ **Framework** | PHP core built around logistics and supply chain abstractions to streamline extension development. | | 🔄 **Dynamic** | Configurable rules, flows and logic to enable automation and customization. | | 🎨 **UI/UX** | Clean, responsive user-friendly interface for efficient management and operations from desktop or mobile. | | 📊 **Dashboards** | Create custom dashboards and widgets to get full visibility into operations. | | 📈 **Scalability** | Uninterrupted growth with scalable infrastructure and design, capable of handling increasing data volume and user demand as your business expands. | | 🔄 **Continuous Improvements** | Commitment to continuous improvement, providing regular updates that seamlessly introduce optimizations, new features, and overall enhancements to the OS. | | 🌍 **Open Source** | Deploy it either on-premise or in the cloud according to your organization's needs and preferences. | ## 💾 Install The easiest way to get started with Fleetbase is using the Fleetbase CLI, which automates the entire Docker-based installation process. For local setup options, read the [running locally quickstart in the Fleetbase documentation](https://www.fleetbase.io/docs/platform/quickstart/running-locally). ### Prerequisites - Node.js v22 - Docker and Docker Compose - Git ### Quick Install with CLI ```bash # Install the Fleetbase CLI globally npm install -g @fleetbase/cli # Run the interactive installer flb install-fleetbase ``` ### Alternative Install Script You can also use the install script directly: ```bash git clone [email protected]:fleetbase/fleetbase.git cd fleetbase && ./scripts/docker-install.sh ``` ### Accessing Fleetbase Once successfully installed and running you can then access the Fleetbase console on port 4200 and the API will be accessible from port 8000. Fleetbase Console: http://localhost:4200 Fleetbase API: http://localhost:8000 ### Additional Configurations **CORS:** If you're installing directly on a server you will need to configure the environment variables to the application container: ``` CONSOLE_HOST=http://{yourhost}:4200 ``` If you have additional applications or frontends you can use the environment variable `FRONTEND_HOSTS` to add a comma delimited list of additional frontend hosts. **Application Key** If you get an issue about a missing application key just run: ```bash docker compose exec application bash -c "php artisan key:generate --show" ``` Next copy this value to the `APP_KEY` environment variable in the application container and restart. **Routing:** Fleetbase ships with a default OSRM server hosted by [router.project-osrm.org](https://router.project-osrm.org) but you're able to use your own or any other OSRM compatible server. You can modify this in the `console/environments` directory by modifying the .env file of the environment you're deploying and setting the `OSRM_HOST` to the OSRM server for Fleetbase to use. **Services:** There are a few environment variables which need to be set for Fleetbase to function with full features. If you're deploying with docker then it's easiest to just create a `docker-compose.override.yml` and supply the environment variables in this file. ```yaml version: "3.8" services: application: environment: CONSOLE_HOST: http://localhost:4200 MAIL_MAILER: (ses, smtp, mailgun, postmark, sendgrid) OSRM_HOST: https://router.project-osrm.org IPINFO_API_KEY: GOOGLE_MAPS_API_KEY: GOOGLE_MAPS_LOCALE: us TWILIO_SID: TWILIO_TOKEN: TWILIO_FROM: socket: environment: # IMPORTANT: Configure WebSocket origins for security # Development (localhost only - include WebSocket protocols): SOCKETCLUSTER_OPTIONS: '{"origins":"http://localhost:*,https://localhost:*,ws://localhost:*,wss://localhost:*"}' # Production (replace with your actual domain): # SOCKETCLUSTER_OPTIONS: '{"origins":"https://yourdomain.com:*,wss://yourdomain.com:*"}' ``` **WebSocket Security:** The `SOCKETCLUSTER_OPTIONS` environment variable controls which domains can connect to the WebSocket server. Always restrict origins to your specific domains in production to prevent security vulnerabilities. You can learn more about local installation and configuration in the [official documentation](https://www.fleetbase.io/docs/platform/quickstart/running-locally). ## ⌨️ Fleetbase CLI The Fleetbase CLI is a powerful tool for managing your Fleetbase instance. It simplifies installation, extension management, authentication, and development workflows. Install the CLI globally with npm: ```bash npm install -g @fleetbase/cli ``` ### Available Commands | Command | Description | |---------|-------------| | `flb install-fleetbase` | Install Fleetbase using Docker with interactive setup | | `flb set-auth <token>` | Set your registry authentication token for installing extensions | | `flb search [query]` | Search and browse available extensions | | `flb install <extension>` | Install an extension to your Fleetbase instance | | `flb uninstall <extension>` | Uninstall an extension from your instance | | `flb register` | Register a Registry Developer Account | | `flb verify` | Verify your developer account email | | `flb login` | Authenticate with the registry (for publishing extensions) | | `flb scaffold` | Scaffold a new extension for development | | `flb publish` | Publish an extension to the registry | | `flb generate-token` | Generate or regenerate your registry authentication token | # 🧩 Extensions Extensions are modular components that enhance the functionality of your Fleetbase instance. They allow you to add new features, customize existing behavior, or integrate with external systems. ### Browsing Extensions ```bash flb search # list all extensions flb search fleet # search by keyword flb search --category logistics flb search --free flb search --json # machine-readable output ``` ### Installing Extensions To install extensions on a self-hosted instance: ```bash # 1. Register an account (one-time) flb register # 2. Verify your email (one-time) flb verify -e [email protected] -c verification-code # 3. Generate your registry token flb generate-token -e [email protected] # 4. Set your authentication token flb set-auth your-registry-token-here # 5. Install an extension flb install <extension> ``` **Example:** ```bash flb install fleetbase/pallet flb install fleetbase/fleetops ``` ### Developing Extensions You can develop and publish your own extensions to extend Fleetbase's functionality or monetize through the marketplace. Learn more in the [extension development quickstart](https://www.fleetbase.io/docs/extension-development/getting-started/quickstart). ```bash # 1. Register a developer account (one-time) flb register # 2. Verify your email flb verify -e [email protected] -c verification-code # 3. Scaffold a new extension flb scaffold # 4. Authenticate for publishing flb login -u your-username -p your-password -e [email protected] # 5. Publish to the registry flb publish ``` # 📱 Apps Fleetbase offers open-source mobile apps that can be customized and deployed: | App | Description | Platform | Repository | |-----|-------------|----------|------------| | **Storefront App** | E-commerce/on-demand app for launching your own shop or marketplace | iOS & Android | [GitHub](https://github.com/fleetbase/storefront-app) | | **Navigator App** | Driver app for managing orders with real-time location tracking | iOS & Android | [GitHub](https://github.com/fleetbase/navigator-app) | ## 🛣️ Roadmap | Feature | Status | Expected Release | Description | |---------|--------|------------------|-------------| | **Pallet (WMS)** | 🚧 In Development | Q2 2026 | Inventory and Warehouse Management extension | | **AI Agent** | 🔬 Research | Q4 2026 | AI integration for system and workflow automation | | **Dynamic Rules** | 📋 Planned | 2027 | Rule builder to trigger events, tasks, and jobs | Want to influence our roadmap? [Join the discussion](https://github.com/orgs/fleetbase/discussions) ## 🚀 Deployment Options | Option | Best For | Setup Time | Maintenance | |--------|----------|------------|-------------| | **Docker (Local)** | Development & Testing | 5 minutes | Self-managed | | **On-Premise** | Production on your own infrastructure | 30-60 minutes | Self-managed | | **Cloud Self-Hosted** | Production (AWS, GCP, Azure) | 30-60 minutes | Self-managed | | **Fleetbase Cloud** | Quick start, no DevOps | Instant | Fully managed | [View the cloud deployment guide →](https://www.fleetbase.io/docs/platform/quickstart/deploy-in-cloud) ## 🐛 Bugs and 💡 Feature Requests Have a bug or a feature request? Please check the <a href="https://github.com/fleetbase/fleetbase/issues">issue tracker</a> and search for existing and closed issues. If your problem or idea is not addressed yet, please <a href="https://github.com/fleetbase/fleetbase/issues/new">open a new issue</a>. ## 📄 Documentation Fleetbase has comprehensive documentation to help you get started and make the most of the platform: - **Getting Started**: [Run Fleetbase locally](https://www.fleetbase.io/docs/platform/quickstart/running-locally) - **API Reference**: [API Documentation](https://www.fleetbase.io/docs/api) - **Developer Console**: [API keys and integration setup](https://www.fleetbase.io/docs/platform/developer-console/api-keys) - **Extension Development**: [Extension quickstart](https://www.fleetbase.io/docs/extension-development/getting-started/quickstart) - **Deployment**: [Deploy Fleetbase in the cloud](https://www.fleetbase.io/docs/platform/quickstart/deploy-in-cloud) ## 🤝 Contributing We welcome contributions from the community! Here's how you can help: - **Report Bugs**: [Open an issue](https://github.com/fleetbase/fleetbase/issues/new) - **Suggest Features**: [Start a discussion](https://github.com/orgs/fleetbase/discussions) - **Submit PRs**: Read our [Contributing Guide](https://github.com/fleetbase/fleetbase/blob/main/CONTRIBUTING.md) - **Write Documentation**: Help improve our [docs](https://www.fleetbase.io/docs) - **Build Extensions**: Create and share [extensions](https://www.fleetbase.io/docs/extension-development/getting-started/quickstart) **Development Setup**: See our [Development Setup Guide](https://www.fleetbase.io/docs/platform/quickstart/development-setup) for detailed instructions on setting up your local development environment. ## 👥 Community Get updates on Fleetbase's development and chat with the project maintainers and community members by joining our <a href="https://discord.gg/V7RVWRQ2Wm">Discord</a>. <ul> <li>Follow <a href="https://x.com/fleetbase_io">@fleetbase_io on X</a>.</li> <li>Read and subscribe to <a href="https://www.fleetbase.io/blog-2">The Official Fleetbase Blog</a>.</li> <li>Ask and explore <a href="https://github.com/orgs/fleetbase/discussions">our GitHub Discussions</a>.</li> </ul> <p dir="auto">See the <a href="https://github.com/fleetbase/fleetbase/releases">Releases</a> section of our GitHub project for changelogs for each release version of Fleetbase.</p> <p>Release announcement posts on <a href="https://www.fleetbase.io/blog-2" rel="nofollow">the official Fleetbase blog</a> contain summaries of the most noteworthy changes made in each release.</p> ## Creators <table style="border: none;"> <tr> <td align="center" style="border: none;"> <img src="https://user-images.githubusercontent.com/58805033/230263021-212f2553-1269-473d-be94-313cb3eecfa5.png" alt="Ronald A. Richardson" width="120" height="120" style="border-radius: 50%;"> <br> <strong>Ronald A. Richardson</strong> <br> Co-founder & CTO <br> <a href="https://github.com/orgs/fleetbase/people/roncodes">GitHub</a> | <a href="https://www.linkedin.com/in/ronald-a-richardson/">LinkedIn</a> </td> <td align="center" style="border: none;"> <img src="https://user-images.githubusercontent.com/58805033/230262598-1ce6d0cc-fb65-41f9-8384-5cf5cbf369c7.png" alt="Shiv Thakker" width="120" height="120" style="border-radius: 50%;"> <br> <strong>Shiv Thakker</strong> <br> Co-founder & CEO <br> <a href="https://github.com/orgs/fleetbase/people/shivthakker">GitHub</a> | <a href="https://www.linkedin.com/in/shivthakker/">LinkedIn</a> </td> </tr> </table> # License & Copyright Fleetbase is available under a **dual-licensing model** to accommodate both open-source community users and commercial enterprises: ## Open Source License (AGPL-3.0) By default, Fleetbase is licensed under the [GNU Affero General Public License v3.0 (AGPL-3.0)](https://www.gnu.org/licenses/agpl-3.0.html). This license allows you to use, modify, and distribute Fleetbase freely, provided that: - Any modifications or derivative works are also made available under AGPL-3.0 - If you run a modified version as a network service, you must make the source code available to users The AGPL-3.0 is ideal for open-source projects, academic research, and organizations committed to sharing their improvements with the community. ## Commercial License (FCL) For organizations that require more flexibility, Fleetbase offers a **Fleetbase Commercial License (FCL)** that provides: - **Freedom from AGPL obligations** – Deploy and modify Fleetbase without source code disclosure requirements - **Proprietary integrations** – Build closed-source extensions and integrations - **Commercial protections** – Warranties, indemnities, and legal assurances not provided under AGPL - **Derivative work ownership** – Retain full ownership of your modifications and customizations - **Flexible licensing options** – Choose from annual, monthly, or perpetual license models ### Commercial License Options | License Type | Price | Support & Updates | Best For | |--------------|-------|-------------------|----------| | **Annual License** | $25,000/year | ✅ All upgrades & Business Support included | Organizations requiring continuous updates and support | | **Monthly License** | $2,500/month | ✅ All upgrades & Business Support included | Pilot projects and short-term deployments | | **Major Version License** | $25,000 (one-time) | ❌ No ongoing support | Stable deployments on a single major version | | **Minor Version License** | $15,000 (one-time) | ❌ No ongoing support | Locked version deployments | ### When You Need a Commercial License You should consider a commercial license if you: - Want to build proprietary extensions or integrations without open-sourcing them - Need to embed Fleetbase in a commercial product without AGPL obligations - Require enterprise-grade support, SLAs, and legal protections - Plan to modify Fleetbase without sharing your changes publicly ### Get a Commercial License For more information about commercial licensing options, please contact us: - **Email:** [[email protected]](mailto:[email protected]) - **Website:** [fleetbase.io](https://fleetbase.io) --- **Copyright © 2026 Fleetbase Pte. Ltd.** All rights reserved.