Skip to content
Merged
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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/guides/admin/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Admin",
"position": 7,
"link": {
"type": "generated-index",
"description": "Getting Started with using Fleetbase"
}
}
Binary file added docs/guides/admin/image-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/admin/image-10.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/admin/image-11.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/admin/image-12.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/admin/image-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/admin/image-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/admin/image-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/admin/image-5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/admin/image-6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/admin/image-7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/admin/image-8.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/admin/image-9.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/admin/image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
91 changes: 91 additions & 0 deletions docs/guides/admin/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
---
title: Introduction
sidebar_position: 1
slug: /guides/admin/introduction
---

## Admin Overview

The admin console is where you configure the system wide settings such as 3rd party services, billing configurations, visibility controls etc.

To access the system admin navigate to https://console.fleetbase.io/admin/

### Organisations

View all of the organisations and users signed up to your Fleetbase instance.

![Alt text](image.png)

### Branding

Upload your icon and logo for branding your Fleetbase instance.

![Alt text](image-1.png)

### Notifications

Set up users to recieve system wide notifications.

![Alt text](image-2.png)

### 2FA Config

Configure the 2FA functions for your Fleetbase instance.

![Alt text](image-3.png)

### Visibility Controls

Select which FleetOps modules are visibile to the users of your Fleetbase instance.

![Alt text](image-4.png)

### Navigator App

To use our existing published Navigator App with your Fleetbase instance, you need to create a instance linking URL. You can do so in the screenshot below.

![Alt text](image-5.png)

### Avatar Management

Create an upload the avatars that you want users to use in your Fleetbase instance for vehicles, places and drivers.

![Alt text](image-6.png)

### Services

Add in your API Keys for 3rd party services such as Google Maps, AWS, Twilio & Sentry in the Services section.

![Alt text](image-7.png)

### Mail Config

Set up your mail server for sending emails from your Fleetbase instance.

![Alt text](image-8.png)

### Filestorage

Set up your file storage configurations so users can upload files in your Fleetbase instance.

![Alt text](image-9.png)

### Queue Config

Set up your queue service for your Fleetbase instance.

![Alt text](image-10.png)

### Socket Cluster

Test socket connection.

![Alt text](image-11.png)

### Notification Channels

Set up notifications system wide for your Fleetbase instance.

![Alt text](image-12.png)


8 changes: 8 additions & 0 deletions docs/guides/console/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Console",
"position": 1,
"link": {
"type": "generated-index",
"description": "Getting Started with using Fleetbase"
}
}
23 changes: 23 additions & 0 deletions docs/guides/console/dashboard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Dashboard
sidebar_position: 2
slug: /guides/console/dashboard
---

## Dashboard Overview

The dashboard is your centralised place for a complete overview of your operations, fully configurable and customizable.

![Alt text](image.png)

### Create New Dashboard

You can create as many dashboards as you need, click on the 'Dashboard' on the top right to create a new dashboard.

![Alt text](image-1.png)

### Widgets

The dashboard is compiled of 'Widgets'. Fleetbase comes with standard widgets for insights into metric for FleetOps and Storefront. Users can create their own custom widgets or reach out to one of our team for the same.

To learn more, please visit the 'Widgets' section.
Binary file added docs/guides/console/image-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/console/image-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/console/image-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/console/image-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/console/image-5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/console/image-6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/console/image-7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/console/image-8.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/console/image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
44 changes: 44 additions & 0 deletions docs/guides/console/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: Overview
sidebar_position: 1
slug: /guides/console/overview
---
## Console Overview

The console is the backbone of Fleetbase. It shows all of your installed extensions, cutomized dashboards and your company / user settings.

### Navigation Bar

The top navigation bar shows all of your extensions currently available.

![Alt text](image-2.png)

### Dashboard

As you enter the console, you will see the Dashboard.

This dashboard is fully customizble, you can learn more in the Dashboard Section.

![Alt text](image-3.png)

### Notifications / Chat / Translation

View all of your system notifications, switch to multiple languages and create instant chat channels using the features in the screenshot below:

![Alt text](image-4.png)

### Company & User Settings

Click into the Company Name or the User Profile Image to access settings such as:

- Organisation Settings
- Create or Join or Switch Organisations
- Update Billing Settings
- Explore Extensions
- Access System Admin
- View or Update Profile / Passwords

![Alt text](image-5.png)



21 changes: 21 additions & 0 deletions docs/guides/console/widgets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Widgets
sidebar_position: 3
slug: /guides/console/widgets
---

## Widgets

The dashboard is compiled of 'Widgets'. Fleetbase comes with standard widgets for insights into metric for FleetOps and Storefront. Users can create their own custom widgets or reach out to one of our team for the same.

### Create New Widget

Once you have created a new Dashboard, you can then add the exisiting Widgets to this dashboard.

Click on the ... dots on the right top corner, and then click 'Add Widgets'.

![Alt text](image-8.png)

Once you are here, you can select the widgets you need. If you are looking to create new widgets, you can do so from the back end, or reach out to the team.

![Alt text](image-7.png)
8 changes: 8 additions & 0 deletions docs/guides/developers-console/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Developers Console",
"position": 3,
"link": {
"type": "generated-index",
"description": "Getting Started with using Fleetbase"
}
}
Binary file added docs/guides/developers-console/image-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/developers-console/image-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/developers-console/image-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/developers-console/image-4.png
Binary file added docs/guides/developers-console/image-5.png
Binary file added docs/guides/developers-console/image.png
33 changes: 33 additions & 0 deletions docs/guides/developers-console/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: Introduction
sidebar_position: 1
slug: /guides/console/introduction
---
## Overview

The Developers console allows you to have an overview of your activity, and create the API Keys and Webhooks you need to integrate and run Fleetbase programatically.

1. **Insights** - View API insights.

![Alt text](image.png)

2. **API Keys** - Create and view API Keys.

![Alt text](image-1.png)

3. **Webhooks** - Create and view webhook endpoints.

![Alt text](image-2.png)

4. **WebSockets** - View your webhooks success and errors.

![Alt text](image-3.png)

5. **Logs** - View all of the logs for your account.

![Alt text](image-4.png)

6. **Events** - View all of the logs for your account.

![Alt text](image-5.png)

2 changes: 1 addition & 1 deletion docs/guides/fleet-ops/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "Fleet-Ops",
"position": 3,
"position": 2,
"link": {
"type": "generated-index",
"description": "Getting Started with using Fleetbase"
Expand Down
30 changes: 30 additions & 0 deletions docs/guides/fleet-ops/contacts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: Contacts
sidebar_position: 10
slug: /guides/fleet-ops/contacts
---

## Overview

Contacts can be defined in multiple ways.

1. **Contacts** - Contacts can be any contacts you wish to document in the system, such as contractors / stakeholdersetc.
2. **Customers** - Customers can be the end customer your want to assign deliveries to.

![Alt text](image-40.png)

### Create Contact / Customer ###

You can create a new contact by clicking on the button on the top of the panel.

1. **Contact Details** - Populate your contact / customer details.
2. **Type** - Select from the list to select either 'Contact' or 'Customer'.

![Alt text](image-41.png)


### Export Contacts ###

Export contacts by selecting the contacts and then clicking the 'Export' button.

![Alt text](image-42.png)
65 changes: 65 additions & 0 deletions docs/guides/fleet-ops/dashboard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
title: Dashboard
sidebar_position: 2
slug: /guides/fleet-ops/dashboard
---

## Overview

The map view in FleetOps is probabsly where you will spend most of your time.

Here, you can have a full overview of all of your drivers locations in real time, as well create and view orders, create and view service areas and add custom zoning.

### Map View

The map view shows a visual representation of the drivers, this is using the GPS from the mobile device, as long as the driver is online using the Navigator App you will be able to see their location.

![Alt text](image.png)

#### Create Order

You can create an order directly from the dashboard by clicking on the 'Create New Order' button, or by clicking the first button in the left side bar.

![Alt text](image-5.png)

Navigate to the 'Orders' section to learn more.

#### View Orders

You can view orders directly from the dashboard by clicking the 3rd button on the left side bar.

![Alt text](image-8.png)

Navigate to the 'Orders' section to learn more.

#### Search

You can search for your order by simply clicking the second button on the left side bar, and then searching in the box above.

![Alt text](image-7.png)

#### Create Service Areas

You can create an service area directly from the dashboard by clicking on the 'Create New Service Area' button, or by clicking the fourth button in the left side bar.

![Alt text](image-6.png)

Navigate to the 'Service Areas' section to learn more.

### Table View

The Table View in FleetOps shows a full list of the orders created by the users in FleetOps, from here, you can bulk action orders, see the statuses of orders, and export all of your order details.

![Alt text](image-9.png)

#### Custom Columns

Users can view and hide all of the columns they want to see in the table view. Simple click the columns tab and check or uncheck the required fields.

![Alt text](image-10.png)

#### Bulk Actions

Once you select orders from the Table View, you can commit bulk actions on these orders. Simply navigate to the 'Bulk Action' button on the top right.

![Alt text](image-12.png)
29 changes: 29 additions & 0 deletions docs/guides/fleet-ops/drivers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: Drivers
sidebar_position: 6
slug: /guides/fleet-ops/drivers
---

## Overview

Drivers can be used to assign new orders, vehicles and fleets to.

![Alt text](image-28.png)

### Create Drivers

You can create new orders by clicking on the button on the top of the panel.

1. **User Account** - If the driver has an exisiting user account in the system, you can link this account to create the new driver.
2. **Driver Details** - Add in the details of the driver.
3. **Avatar** - Select an avatar, this will be displayed when you view the driver on the map.
4. **Navigator App** - The phone number you add to the driver will be used to login to the Driver app once you assign the order to them.


![Alt text](image-29.png)

### Export Drivers ###

Export drivers by selecting the drivers and then clicking the 'Export' button.

![Alt text](image-30.png)
Loading