Fleetbase
Modular logistics and supply chain operating system (LSOS)
Install / Use
/learn @fleetbase/FleetbaseREADME
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
npm install -g @fleetbase/cli
flb install-fleetbase
📖 Table of contents
- Features
- Install
- Extensions
- Apps
- Roadmap
- Deployment Options
- Bugs and Feature Requests
- Documentation
- Contributing
- Community
- Creators
- 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. If you'd like to use Fleetbase without Docker, read the full install guide in the Fleetbase documentation.
Prerequisites
- Node.js (v14 or higher)
- Docker and Docker Compose
- Git
Quick Install with CLI
# 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:
git clone git@github.com: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:
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 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.
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 full installation, and configuration in the official documentation.
