Skip to main content
Fleetview logo

Documentation

Overview

To get the most out of Fleetview you can keep track of all of the environments, websites and servers.

Servers

Add servers to keep track of all of the important details relating to your servers such as the IP address, contact info and costs. Each of your environments can be related to a server so you and your team know have the details they need to work on the site.

Adding a server

Environments

An environment is an instance of your website. You might have multiple staging environments and a lovely site, or maybe you only have a live site. It's up to you which environments you track.

Adding an environment

Websites

A website is the parent of the environment and it represents the overall web project. A website can have multiple environments.

Adding a website

 

Servers

Adding a server

Adding a new server page to manage the details of your organisation's servers.

  1. From your dashboard, click on +Add then +Add server
  2. Add a title for the server
  3. Optionally you can add other details such as the server IP address, specification notes, account information, cost description and the hosting company. See Server fields for more information
  4. Optionally you can add additional content. See adding additional content to your records.
  5. Click Save

Server fields

 

IP addressThe IP address of the server
Server specificationDetails of the specification such as RAM, cores and storage
Account ownerContact name of the person that manages the hosting account
Cost descriptionUse this to keep track of the server costs
Hosting companyName of the hosting company

Websites

Adding a new website page to manage the details of your organisation's websites.

Adding a website

  1. From your dashboard, click on +Add then +Add website
  2. Add a title for the environment
  3. Optionally you can add the git repository URL
  4. Optionally you can add additional content. See adding additional content to your records.
  5. Click Save

Website fields

Git URLThe URL of the git repository of the website project
Issue tracker URLThe URL of the issue tracker for this project, eg, Jira

Environments

Environments are the different instances of your website. You may just have a live environment, but more likely you have at least one staging environment. 

Creating a new environment page to manage the details of your organisation's environments.

Adding an environment

  1. From your dashboard, click on +Add then +Add environment
  2. Add a title for the environment
  3. Select the environment type
  4. Add the environment's URL
  5. Optionally add a link to the environment's server
  6. Add a link to the environment's Website. This is optional, but highly recommended for organising your data
  7. Add the connection token for the environment. This can be found on the website for the environment. See Installing the Fleetview client module.
  8. Optionally add other details such as HTTP authentication credentials, IP address and Google analytics ID
  9. Optionally you can add additional content. See adding additional content to your records.
  10. Click Save

Environment fields

Environment typeDevelopment/live/staging/other
URLThe URL of the environment. Used for retrieving data from the client module
ServerLink to the server the environment is on
WebsiteLink to the website the environment is a part of
TokenThe connection token generated by the Fleetview client module on the client site
HTTP usernameLogin username for sites behind  HTTP authentication
HTTP passwordLogin password for sites behind  HTTP authentication - do not use for sensitive passwords
IP addressIP address of the environment
Google analytics IDGoogle analytics ID for the environment
Domain name registrarName of the registrar for the domain - where the domain is managed

Installing the Fleetview client module

The Fleetview client module provides the environments data such as module status and status report to your Fleetview dashboard. The data is accessible only using a secure key generated for each environment. The data is also encrypted so that it can only be read by the Fleetview dashboard.

  1. Run composer require drupal/fleetview_client
  2. Enable the module through the Extend page or by running drush en fleetview_client
  3. Go to Configuration > System > Fleetview client
  4. Here you will find the Connection token which you need to enrol the new environment on your dashboard

Adding additional content to your records

All environments, websites and servers can have additional content. You can add documents, links, notes and snippets.

DocumentsAdd relevant documents or PDFs that could be useful such as the technical specification, or brand guidelines
LinksAdd relevant links
NotesAdd text notes
SnippetsAdd snippets such as frequently used commands