Desktop Free Launch


Getting Started

Activate a GitPitch Paid Plan to unlock GitPitch Desktop Pro Edition.

The following sections guide you through the activation, installation, and launch of Desktop Free:

For additional information including answers to frequently asked questions see the Desktop Free FAQ.


Step 1. Prerequisite: Register with GitPitch

To install Desktop Free you must first register on the GitPitch website. Registering is 100% free and simply requires you to login to the GitPitch website using an existing GitHub, GitLab, or Bitbucket account. To register now, login here at https://gitpitch.com/login/free.


Step 2. Prerequisite: Install Docker

Desktop Free is delivered as a Docker desktop image.

The Docker runtime aka. Docker Desktop is available for MacOS, Linux, and Windows 10. If you do not have Docker installed on your desktop, please install it now.

Important! Windows 10 Home edition is currently not supported.

Docker installation instructions can be found here:

The simplest way to verify your Docker installation is to run the following command:

docker run hello-world.

If running this command fails for any reason, you will need to resolve those issues before moving ahead to the next step.


Step 3. Prerequisite: Register Docker ID

As noted above, Desktop Free is delivered as a Docker desktop image. The desktop image is maintained within a private repository on Docker Hub. So in order to download the image you must first register a valid Docker Hub ID with GitPitch.

We will contact you by email as soon as we have verified your Docker Hub ID and granted you the necessary permissions to download the image. To register your Docker ID simply login to the GitPitch website and complete the GitPitch Desktop Access Management form.

You can login to register your Docker ID on the GitPitch website here.

Important! It may take up to 24 hours before you receive the confirmation email that will grant you access to the desktop image. Thank you for your patience.


Step 4. Desktop Free Download Instructions

Please ensure your Docker ID has been confirmed by email before moving ahead with this download.

In order to download the desktop image you first need to login to Docker Hub at your command line. You can login using the following command:

docker login

Once you can confirm a successful login you are ready to download the desktop image:

docker pull gitpitch/free

Allow the download process to complete. This may take a few minutes the first time you run this command. In the future, you can use this same command to pull any updates to the desktop image.

Once the download process has completed you are then ready to move ahead to the final step, launching Desktop Free.


Step 5. Desktop Free Launch Instructions

The following launch instructions assume you have completed the following:

  1. You have successfully registered on the GitPitch website.
  2. You have verified your local Docker installation.
  3. You have registered your Docker Hub ID and received confirmation from us.
  4. You have downloaded the Desktop Free image from Docker Hub.

If you have not completed all of these steps, please refer to the step-by-step instructions above.

When launching Desktop Free you must indicate a path to a local working directory. This path tells the desktop where on the local file system it needs to monitor for changes you make to your presentation files.

Typically this directory is a local Git repository. Although it can be any directory on the local file system.

The default launch command for Desktop Free is as follows:

docker run -it -v {WORKINGDIR}:/repo -p 9000:9000 gitpitch/free

Note, {WORKINGDIR} is a placeholder. You must replace it with an absolute path to a working directory on your local file system where your presentation files are found.

For example, here is a sample launch command on Mac OSX:

docker run -it -v /Users/david/hello-world:/repo -p 9000:9000 gitpitch/free

And here is a sample launch command on Windows:

docker run -it -v c:/david/hello-world:/repo -p 9000:9000 gitpitch/free

Upon successful launch you should be able to access Desktop Free in your browser at the following URL:

http://localhost:9000

To open your browser at the default Desktop URL, just click here.