WinGIN - Usage Walkthrough

Contents

1. Download
2. Installation
3. Setting Global Options
4. Checking-out a repository
5. Creating a repository
6. Removing a repository
7. Getting older version of file

Requirements

.NET Framework 4.6.1 or higher must be present in the system, otherwise you will be asked to install it, before installation starts.

Download

Go to WinGIN installation website and download both setup.exe and Setup.msi files to a local directory.

Installation

Install WinGIN and Dokan following the steps below:

WinGIN Installation:

Step 1: Run setup.exe and proceed with next button.

Step 2: Read the license and click agree.

Step 3: Select the installation directory and whether the installation is just for current user or for everyone.

Step 4: Finally confirm installation.

Step 5: Wait until the installation is complete. NOTE: The installation requires an internet connection to download the GIN client in the background, which is required by WinGIN.

Dokan Installation:

Dokan is a separate piece of software required by WinGIN. At the end of the WinGIN installation, there is a checkbox that asks if you want to Install Dokan. You should keep this box checked and click "Close". You should only uncheck the box if Dokan is already installed, for instance from a previous WinGIN installation. If you are unsure, keep the box checked and the Dokan installation will inform you if an installation is required.

Step 1: Select the option "Install Dokan". You can unselect this if Dokan has already been installed. Then click on "Close".

Step 2: Read and agree to the license.

Step 3: Wait until Dokan is installed

Setting Global Options

Setting period for repository update checks

WinGIN checks for repository updates every 15 minutes by default and updates the local workspace and internal storage accordingly. Period of the automatic update can be changed by clicking on the "Check for Repository updates" dropdown menu in "Setting Global Options" tab of WinGIN and by choosing another time period (5, 30 or 60) or it can be switched off by choosing "Never".

Setting checkout directory (Internal storage)

Checkout directory is the local directory where checked-out files are downloaded into. This directory will contain the actual files downloaded from the GIN server. The main reason to change this directory is if you believe that the main system drive may not have space to store downloaded repositories. In this case, you may want to change it to a different drive or folder.

The default checkout directory is C:\Users\<username>\AppData\Roaming\g-node\GinWindowsClient\Repositories, but it can be changed by clicking on the browse button next to "Default Checkout Directory" and choosing a new folder.

Setting mountpoint directory (Workspace)

The Mountpoint Directory is the directory in which you will interact with your files. While the data is stored in the Checkout Directory described above, the repositories will appear in the Mountpoint Directory. Any changes you make in the Mountpoint Directory will be reflected in the Checkout Directory.

The default Mounpoint Directory is C:\Users\<username>\Desktop\Gin Repositories (the Windows Desktop). However, it can be changed by clicking on the browse button next to the "Default Mountpoint Directory" and choosing a new folder.

Note on selecting Checkout and Mountpoint directories: The Mountpoint Directory should be a convenient location where you can easily find your files and work in, such as your Desktop or home/documents directory. Conversely, the Checkout Directory should be in a location you don't interact with (such as the AppData folder, which is the default). You should never interact with the files in the Checkout Directory unless you are advised to for troubleshooting reasons.

Download all Annexed Data option

When this option is on, all large files will be downloaded upon checkout from the repository. However, when it is off, only the file structure of the checked-out repository will be downloaded. Large files will instead be represented by small pointer files. Double clicking on a pointer file, or right clicking and selecting the download option from the Gin Repository submenu, will initiate a download of its content.

Checking-out a repository

You can checkout an existing repository following the steps below:

Step 1: Open the "Repositories" tab of WinGIN.

Step 2: Click on "Checkout" button.

Step 3: Enter > username/repository or select existing repository from the list with Browse button, check your checkout directory and mountpoint and proceed with clicking on "OK".

Step 4: Then, WinGIN will download the files into checkout directory and will download the file structure of the repository into mountpoint directory.

Step 5: After checking-out files into your local workspace, you can reach them via the mountpoint directory.

Creating a repository

You can also create a new repository via WinGIN as the following:

Step 1: Click on "Create New" button at the "Repositories" tab.

Step 2: Proceed with entering your > username/repository and click on "OK".

You will see your new repository at the "Managed Repositories" list!

Removing a repository

Checked-out and newly created repositories can be removed from your local workspace as the following:

Step 1: Click on the repository that you want to remove at the "Managed Repositories" list.

Step 2: Click on "Remove" button.

Your repository is removed from you local workspace now!

NOTE: However, your repository will continue to exist on GIN. It can only be deleted using the GIN web interface (see here for a guide).

Uploading changes to a repository

You can add, delete or change files in your repositories from your local workspace. To do that, first open the mountpoint directory, which is the "Gin Repositories" folder on your desktop by default and follow the steps below.

Deleting a file from your repository

Step 1: After navigating to the mountpoint directory, delete the file that you want to remove from your repository.

Step 2: Right click on the WinGIN icon at the system tray, then click on your repository name and "Upload Changes".

Step 3: A list of files that are going to be removed will pop up, proceed with "OK".

The deleted file will be removed from your repository as well as your local directory. You can check it using the web interface.

Adding a file to your repository

Step 1: Paste the file you want to add to your repository into the mountpoint directory.

Step 2: Right click on the WinGIN icon at the system tray, then click on your repository name and "Upload Changes".

You can also upload changes by context menu. With right clicking on the new file, then clicking on "Gin Repository" and "Upload File". NOTE: Context menu is available only if you are browsing repository through moutpoint link.

You can now see the new file in your repository using the web interface.

Changing a file in your repository

You can also change the content of a file and upload it to your repository via the mountpoint directory.

Step 1: Save any changes that you make in your file.

Step 2: Right click on the WinGIN icon at the system tray, then click on your repository name and "Upload Changes".

Changes at your file will be uploaded to your repository!

Specify commit message

You can edit commit message for changes before uploading.

Step 1: Proceed same as in Adding a file to your repository

Step 2: Write commit message in Upload File Dialog

Getting older version of file

You can get older version of commited file with WinGIN.

Step 1: Right click on file and select "Get older version".

Step 2: Select commited file vesion for recovery.

The older file version will be restored in the same repository folder with specific name: "file_name"-"date_of_file".

Caution: if there is file with same name as restored one, the file will be overwritten.