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.
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.
Websites
A website is the parent of the environment and it represents the overall web project. A website can have multiple environments.
Servers
Adding a server
Adding a new server page to manage the details of your organisation's servers.
- From your dashboard, click on +Add then +Add server
- Add a title for the server
- 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
- Optionally you can add additional content. See adding additional content to your records.
- Click Save
Server fields
IP address | The IP address of the server |
Server specification | Details of the specification such as RAM, cores and storage |
Account owner | Contact name of the person that manages the hosting account |
Cost description | Use this to keep track of the server costs |
Hosting company | Name of the hosting company |
Websites
Adding a new website page to manage the details of your organisation's websites.
Adding a website
- From your dashboard, click on +Add then +Add website
- Add a title for the environment
- Optionally you can add the git repository URL
- Optionally you can add additional content. See adding additional content to your records.
- Click Save
Website fields
Git URL | The URL of the git repository of the website project |
Issue tracker URL | The 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
- From your dashboard, click on +Add then +Add environment
- Add a title for the environment
- Select the environment type
- Add the environment's URL
- Optionally add a link to the environment's server
- Add a link to the environment's Website. This is optional, but highly recommended for organising your data
- Add the connection token for the environment. This can be found on the website for the environment. See Installing the Fleetview client module.
- Optionally add other details such as HTTP authentication credentials, IP address and Google analytics ID
- Optionally you can add additional content. See adding additional content to your records.
- Click Save
Environment fields
Environment type | Development/live/staging/other |
URL | The URL of the environment. Used for retrieving data from the client module |
Server | Link to the server the environment is on |
Website | Link to the website the environment is a part of |
Token | The connection token generated by the Fleetview client module on the client site |
HTTP username | Login username for sites behind HTTP authentication |
HTTP password | Login password for sites behind HTTP authentication - do not use for sensitive passwords |
IP address | IP address of the environment |
Google analytics ID | Google analytics ID for the environment |
Domain name registrar | Name 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.
- Run composer require drupal/fleetview_client
- Enable the module through the Extend page or by running drush en fleetview_client
- Go to Configuration > System > Fleetview client
- 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.
Documents | Add relevant documents or PDFs that could be useful such as the technical specification, or brand guidelines |
Links | Add relevant links |
Notes | Add text notes |
Snippets | Add snippets such as frequently used commands |