GitPitch Desktop


About

GitPitch Desktop is a markdown presentation tool for Linux, Windows, and OSX. This tool lets you develop, preview, and present GitPitch slideshows directly on your desktop. It works whether you are online or offline, no Wifi required.



Step 1. Prerequisites

To install GitPitch Desktop you must first activate a GitPitch Pro subscription. For subscription pricing details and activation links visit the GitPitch website here.


Step 2. Install Instructions

GitPitch Desktop is delivered using Docker, the world’s leading software containerization platform.

Docker is available for Mac, CentOS, Debian, Fedora, Ubuntu, Windows 10 (Pro and Enterprise), and Windows Server 2016 RTM among others. If you do not have Docker installed on your desktop, please install it now. 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 with the installation of GitPitch Desktop.

Assuming you have successfully activated your GitPitch Pro subscription you can download GitPitch Desktop by following the instructions provided by the Docker Store.


Step 3. Launch Instructions

The following Launch instructions assume you have completed the following:

  1. You have successfully activated a GitPitch Pro subscription.
  2. You have verified your local Docker installation.
  3. You have downloaded the GitPitch Desktop image from the Docker Store.

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

When launching GitPitch Desktop you must indicate a path to a local working directory. This path tells GitPitch 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 GitPitch Desktop is as follows:

docker run -it -v {DESKTOPREPO}:/repo -p 9000:9000 store/gitpitch/desktop:pro

Note, {DESKTOPREPO} is a placeholder. You must replace it with an absolute path to a working directory on your local file system where your Git repository 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 store/gitpitch/desktop:pro

And here is a sample launch command on Windows:

docker run -it -v c:/david/hello-world:/repo -p 9000:9000 store/gitpitch/desktop:pro

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

http://localhost:9000

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


Step 4. Synchronize Desktop + Cloud Subscription

To activate the full set of subscription features for presentations that you push from your desktop to GitHub, GitLab, or Bitbucket in the cloud, you must synchronize your GitPitch Desktop subscription obtained from the Docker Store with your account on the GitPitch website.

To synchronize your GitPitch Desktop + Cloud subscription, follow these on-screen instructions.


Frequently Asked Questions


The default Desktop port is 9000. How can I change it?

To set a custom port when launching Desktop simply update the -p port mapping and add a matching PORT environment variable on your launch command.

For example, the following command demonstrates how you can launch GitPitch Desktop using port 80:

docker run -it -v {DESKTOPREPO}:/repo -p 80:80 -e PORT=80 store/gitpitch/desktop:pro

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


My presentation does not auto-refresh as expected. What can I do?

Any time you create, update, or delete a file within your local repository, Desktop will attempt to automatically refresh the presentation in your browser.

If your browser does not auto-refresh (or fails to refresh cleanly) when you write a presentation file, simply save your file again and watch for a refresh. If your browser still does not auto-refresh, use your browser’s reload button to force a refresh.


My local working directory does not have a PITCHME.md. How does Desktop handle this?

If you launch GitPitch Desktop and supply a path to a local working directory that does not contain a PITCHME.md file, the Desktop will automatically present you with a Quickstart option.

By clicking Quickstart a simple presentation template is auto-generated. The files assocated with this template are automatically copied into your local working directory. You can immediately start customizing those files with your own presentation content.


My local working directory has multiple PITCHME.md. How does Desktop handle this?

If you launch GitPitch Desktop and supply a path to a local working directory that contains multiple PITCHME.md files, the Desktop will automatically present you with a list of all the presentations found.

Simply click on any presentation within the list to open and preview the corresponding presentation slideshow.


How can I preview the GitPitch Confidential Mode password challenge form?

GitPitch Pro subscribers can make use of GitPitch Confidential Mode for password-protected presentations as detailed in the GitPitch Security Guide.

Confidential mode allows presentation authors to customize and brand the password challenge form. GitPitch Desktop allows you to develop and preview the challenge form by providing the following dedicated URL:

http://localhost:9000/desktop/confidential