# Preface

Welcome to the Deployit system documentation. This document describes the content of the Deployit documentation and helps you find the information you need.

# Documentation Contents

The Deployit documentation contains all the information needed to install, configure, setup and use Deployit. The documentation consists of the following documents:

- Start Here. This is the document you are currently reading.
- Reference Manual. This document describes generic deployment concepts and basic information about Deployit.
- System Administration Manual. This document describes how to install Deployit and get it ready for first use.
- Graphical User Interface (GUI) Manual. This document describes how to use the Deployit GUI.
- Command Line Interface (CLI) Manual. This document describes how to use the Deployit CLI.
- Packaging Manual. This document describes how to create packages that can be imported into Deployit.
- Customization Manual. This document describes how to customize Deployit for use in your environment.

Deployit comes with several standard plugins, whose documentation is also available:

- Command Plugin Manual. This document describes the Command plugin.
- File Plugin Manual. This document describes the File plugin.
- Generic Model Plugin Manual. This document describes the Generic Model plugin.

# Using the Documentation

Every document is written as a standalone document and can be read separately. References to other documents are included when relevant. Depending on your role, some documents are more relevant than others. The following list contains a suggested reading order for specific roles:

- System Administrator: Reference Manual, System Administration Manual, Command Line Interface (CLI) Manual, Customization Manual.
- Deployer: Reference Manual, Packaging Manual, Command Line Interface (CLI) Manual.
- Developer: Reference Manual, Packaging Manual, Graphical User Interface (GUI) Manual, Customization Manual.
- Manager: Reference Manual, Graphical User Interface (GUI) Manual.

# Online Documentation

There is also an online version of the documentation at XebiaLabs' documentation site. The documentation site contains the latest and most up-to-date copy of the documentation.

# Contacting Deployit Support

To contact Deployit support, use our support desk.

# Quickstart

If you're impatient to get started using Deployit, here is a quick rundown of steps you'll need to take and where to find the relevant information:

- Install Deployit: see System Administration Manual, section Installation Procedure.
- Setup your environment: see System Administration Manual, section Setting up Deployit.
- Import the PetClinic sample application: see Graphical User Interface (GUI) Manual, section Importing Packages or Command Line Interface (CLI) Manual, section Performing a Simple Deployment.
- Deploy the PetClinic sample application: see Graphical User Interface (GUI) Manual, section Initial deployment or Command Line Interface (CLI) Manual, section Performing a Simple Deployment.