jandres/Fleetbase-Mirror-Repo
1
0
Fork 0
mirror of https://github.com/fleetbase/fleetbase.git synced 2025-12-19 22:27:22 +00:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Ron
2023-06-15 17:38:18 +08:00
committed by GitHub
parent 27f1b26684
commit 3ebc6d11cc
1 changed files with 15 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -166,7 +166,7 @@ Getting Fleetbase up and running on your system using Docker and Docker-compose
</li>
<li>
Clone the Fleetbase repository to your local machine:
<pre>bash git clone https://github.com/fleetbase/fleetbase.git</pre>
<pre>git clone git@github.com:fleetbase/fleetbase.git</pre>
</li>
<li>
Navigate to the cloned repository:
@@ -184,7 +184,7 @@ Getting Fleetbase up and running on your system using Docker and Docker-compose
<li>
<strong>Start the Docker daemon:</strong>
Ensure the Docker daemon is running on your machine. You can either start Docker Desktop or either executed by running:
<pre>sudo systemctl start docker</pre>
<pre>service docker start</pre>
</li>
<li>
<strong>Build the Docker containers:</strong>
@@ -193,6 +193,17 @@ Use Docker Compose to build and run the necessary containers. In the root direct
</li>
</ol>
### Additional Steps
<ol>
<li>Fleetbase will try to find the current hostname or public IP address to whitelist in for CORS, but if this fails you will need to manually add your hostname or instance URL to `api/config/cors.php` in the `allowed_origins` array. This will whitelist the console for CORS access to your instance backend.
</li>
<li>🛣 Routing! By default Fleetbase currently will use it's own routing engine which is hosted at <a href="https://routing.fleetbase.io" target="_fleetbase_routing_machine">https://routing.fleetbase.io</a>, this routing engine only works for a few enabled countries which include USA, Canada, Belgium, Spain, Serbia, Taiwan, Malaysia, Singapore, Brunei, Mongolia, India, Ghana. We can enable more regions and countries upon request. There is a Roadmap item to allow users to easily change to any routing engine provider such as Mapbox, Google Maps, and other 3rd Party Routing services. Optionally, you can switch out Fleetase Routing engine with any OSRM compatible service such as OpenStreetMap by changing the console environment variable `OSRM_HOST` which can be found in `console/environments/*.env`.
</li>
<li>If you find any bugs or unexpected issues please <a href="https://github.com/fleetbase/fleetbase/issues/new/choose">post an issue</a> to the repo or join our <a href="https://discord.gg/MJQgxHwN" target="_discord" alt="Fleetbase Discord">Discord</a>.
</li>
</ol>
### Access Fleetbase
Now that Fleetbase is up and running via Docker you can find the console and the API accessible:
@@ -241,9 +252,10 @@ Fleetbase offers a few open sourced apps which are built on Fleetbase which can
# 🛣 Roadmap
<ol>
<li>Install Flow & System Configuration from Console</li>
<li>Open Source Extension Repository</li>
<li>🌎 Internationalize</li>
<li>Multiple and Custom Routing Engine's in FleetOps</li>
<li>Identity & Access Management (IAM) Extension</li>
<li>Inventory and Warehouse Management Extension</li>
<li>Freight Forwarder Quote Parser/ System Extension</li>
</ol>