StarMirror/gitpitch
1
0
Fork 0
mirror of https://github.com/gitpitch/gitpitch.git synced 2024-04-18 07:30:55 +08:00
Code Issues Projects Releases Wiki Activity

Desktop Launch using Docker Dashboard added.

Browse Source
This commit is contained in:
gitpitch 2020-10-04 18:12:35 +01:00
parent 368ae1d175
commit e779a95ccf
2 changed files with 26 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/_images/gitpitch-desktop-docker-dashboard.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 230 KiB

27
docs/desktop/launch.md
View File

@ -4,14 +4,39 @@
This guide assumes that you have successfully [downloaded the desktop app](/desktop/download.md). The following desktop app launch options are available:
- [Use the Docker Dashboard](#use-the-docker-dashboard)
- [Use a Bash Alias](#use-a-bash-alias)
- [Use Docker Run](#use-docker-run)
- [Use Docker Compose](#use-docker-compose)
- [Windows Launch Tips](#windows-launch-tips)
### Use the Docker Dashboard
?> To use the Docker Dashboard you must install or update to Docker Desktop 2.2 or later. You can download the latest release of Docker Desktop [here](https://www.docker.com/products/docker-desktop).
The Docker Dashboard provides an intuitive UI that you can use to manage and launch GitPitch Desktop. This is the recommended approach to launch GitPitch Desktop. If you are prefer to work with a CLI rather than a UI see the other launch options details in this guide.
The following short video introduces Docker Dashboard and demonstrates how it can be used to quickly launch GitPitch Desktop:
<iframe id="youtube" width="900" height="600" src="https://www.youtube.com/embed/Lt1xySQnEpk" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
The video details and demonstrates the steps to launch GitPitch Desktop. The following screenshot is also provided as a quick reference for the main settings described in the video:
![Screenshot showing the Docker Desktop Dashboard](../_images/gitpitch-desktop-docker-dashboard.png)
These settings are summarized again here for your convenience:
1. The **Container Name** describes the purpose of a collection of slide decks in a specific directory.
1. The **Local Host** must always be set to **9000**.
1. The **Host Path** points to a local file system directory that contains your presentation files.
1. The **Container Path** must always be set to **/repo**.
1. After specifying custom values for these settings, click **Run**.
As noted in the video you can define and name multiple container instances for GitPitch Desktop. You can then switch between these instances to launch GitPitch Desktop for different collections of slide decks on your file system.
### Use a Bash Alias
By far the simplest way to launch the desktop app is to create a simple *bash alias* or equivalent for your preferred shell.
The simplest way to launch the desktop app using the command line is to create a simple *bash alias* or equivalent for your preferred shell.
<!-- tabs:start -->