GitPitch Desktop Launch


Interested in taking GitPitch Desktop for a test drive? To start your 7 day free trial and see one-time purchase and subscription pricing options visit the GitPitch website here .

The Desktop launch instructions in this guide assume you have completed the following:

  1. You have activated a GitPitch Free Trial or Paid Plan .
  2. You have Docker Desktop installed.
  3. You have downloaded + installed GitPitch Desktop .

Having these prerequisites in place you have two launch options:

  1. Launch using Docker Run
  2. Quick Launch using a Bash Alias
  3. Launch using Docker Compose

Launch using Docker Run

When you launch the Desktop using the docker run command you need to indicate a local working directory where your presentation files (markdown, images, etc) can be found. The Desktop then monitors this directory on your local file system for changes. When file changes are detected the desktop will automatically update the live preview of your slide deck in the browser.

The default launch command for the Desktop is as follows:

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

Note, {LOCALWORKINGDIR} 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.

The {LOCALWORKINGDIR} is often the root directory of a local Git repository. But the directory does not have to be a Git repository. A regular directory on your local file system can be used.

For example, here is a sample launch command on MacOS:

docker run -it -v /Users/david/test:/repo -p 9000:9000 gitpitch/desktop:pro

And here is a sample launch command on Windows:

docker run -it -v c:/david/test:/repo -p 9000:9000 gitpitch/desktop:pro

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

http://localhost:9000

To open your browser at the default Desktop URL right now, click http://localhost:9000 .

Quick Launch using a Bash Alias

By far the simplest way to launch the Desktop is to use a simple bash alias . Here is the bash alias that I have defined in my own ~/.bashrc file:

alias gpd='docker run -it -v $PWD:/repo -p 9000:9000 gitpitch/desktop:pro'

In this example the gpd alias name stands for GitPitchDesktop. But you can name your alias anything you find easy to remember and simple to type. Once this alias is activated in your shell environment (source ~/.bashrc) you can launch the Desktop in two simple steps:

  1. Move into the local working directory where your presentation files are found.
  2. Execute your custom bash alias to launch the Desktop

For example:

$ cd {LOCALWORKINGDIR}
$ gpd

[info] c.g.s.DesktopService - GitPitch Desktop Pro Edition started.
[info] c.g.s.RefreshService - SWEEP directory watcher detected 10 files in 11 ms.
[info] c.g.s.RefreshService - SWEEP directory watcher using default interval 250 ms.
[info] c.g.s.DesktopService - EXPORT ( PDF / PPTX ) service is enabled.
[info] play.api.Play - Application started (Prod)
[info] p.c.s.NettyServer - Listening for HTTP on /0.0.0.0:9000

Note, {LOCALWORKINGDIR} 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.

The {LOCALWORKINGDIR} is often the root directory of a local Git repository. But the directory does not have to be a Git repository. A regular directory on your local file system can be used.

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

http://localhost:9000

To open your browser at the default Desktop URL right now, click http://localhost:9000 .

Launch using Docker Compose

You can use the docker-compose command as a convenient alternative to docker run . To use Compose you first need to copy and save the following service description into a file on your local disk:

version: '3'
services:
  gitpitch:
    image: gitpitch/desktop:pro
    volumes:
      - .:/repo
    ports:
      - "9000:9000"
    environment:
      - PORT=9000

Following Docker conventions, we recommend saving this service description into a file called docker-compose.yaml.

Now to launch the Desktop copy this file into the local working directory where your presentation files (markdown, images, etc) can be found. Then within that directory, use the following launch command:

docker-compose up

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

http://localhost:9000

To open your browser at the default Desktop URL right now, click http://localhost:9000 .

Tip! Using Docker Compose Custom YAML Naming

As noted above the Docker Compose convention looks for a file named docker-compose.yaml to start a container service. If you prefer to use a custom file name when launching the Desktop you can do so.

For example, if you copied and saved the Desktop service description into a file called gitpitch-launch.yaml you would use it as follows:

docker-compose -f gitpitch-launch.yaml up