Git Winch Guide

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
inifile [2025/06/13 11:36] – cherininifile [2025/07/05 20:05] (current) – admin
Line 1: Line 1:
 ======The Ini File====== ======The Ini File======
  
-====== Git Winch Configuration Guide ======+This section explains how to configure the gitwinch.ini file settings before launching the Git Winch application. All these settings are stored in the application's gitwinch.ini file. 
 + 
 +**Understanding the ini file** 
 + 
 +The ini file contains several lines which has the following format: 
 + 
 +<name>=<value> 
 + 
 +i.e. you will see a name of the setting (one word), an equals-to sign and a value after that. 
 +Do NOT change the name. That is important. You can only change the values //after// the equals-to sign.\ 
 + 
 +These //setting// lines are gathered into various sections. Each section name (one word) is inside square brackets. Do NOT change the names of the sections. 
 + 
 +**Configuration Steps** 
 + 
 +  * Close //Git Winch// if it was running 
 +  * Locate the //Git Winch// gitwinch.ini file in the application folder 
 +  * Open the file in any text editor (e.g. Notepad, Notepad++, VS-Code) 
 +  * Modify the required settings as per your needs 
 +  * Save the file 
 +  * Launch Git Winch application and the settings would take effect
  
-This guide explains how to configure Git Winch application settings before launching the application. All settings are stored in the application's gitwinch.ini file. 
  
 ===== Work Section ===== ===== Work Section =====
  
 ==== WorkFolderRoot ==== ==== WorkFolderRoot ====
 +
 **Purpose:** Defines the root folder that Git Winch monitors for changes. **Purpose:** Defines the root folder that Git Winch monitors for changes.
  
 **Configuration:** **Configuration:**
-  -WorkFolderRoot=D:\data\+  * WorkFolderRoot=D:\data\
  
  
-**How to set:** 
-  - Open the .ini file in a text editor 
-  - Locate the WorkFolderRoot line 
-  - Replace the path with a folder that has read/write permissions 
-  - Use absolute path (e.g., D:\data\) or relative path (e.g., data) 
  
-**Important:** If distributing to others, ensure they update this path for their system.+**Important:** Replace the path with a folder that has read/write permissions. Use absolute path (e.g., D:\data\) or relative path (e.g., data)If distributing to others, tell them they must update this path for their own system.
  
 ==== WorkFolderWarn ==== ==== WorkFolderWarn ====
 +
 **Purpose:** Controls warning when working outside the designated work folder. **Purpose:** Controls warning when working outside the designated work folder.
   * **1** = Show warning when attempting to work outside work folder   * **1** = Show warning when attempting to work outside work folder
Line 28: Line 44:
  
 ==== AutoReadNotes ==== ==== AutoReadNotes ====
 +
 **Purpose:** Controls automatic loading of notes when selecting files. **Purpose:** Controls automatic loading of notes when selecting files.
   * **1** = Auto-load notes for selected files   * **1** = Auto-load notes for selected files
Line 46: Line 63:
 **GreetMessage** **GreetMessage**
 Custom greeting text displayed on application launch Custom greeting text displayed on application launch
-GreetMessage=Have a nice day +  * GreetMessage=Have a nice day
  
 **ShowStatusHints** **ShowStatusHints**
Line 61: Line 77:
 **GitSys** **GitSys**
 Specifies the Git server type. For Gitlab its "Gitlab" for Github its "Github" Specifies the Git server type. For Gitlab its "Gitlab" for Github its "Github"
-  GitSys=Gitlab +  * GitSys=Gitlab
  
 **LockOnLaunch** **LockOnLaunch**
Line 80: Line 95:
 **SystemAPIurl** **SystemAPIurl**
 URL of the coordination server URL of the coordination server
-  SystemAPIurl=https://xxx.yyy.com/api/v1/ +  * SystemAPIurl=https://xxx.yyy.com/api/v1/
  
 **Dashboardurl** **Dashboardurl**
 Login URL used by this app Login URL used by this app
-  Dashboardurl=https://xxx.yyy.com/qlogin.html +  * Dashboardurl=https://xxx.yyy.com/qlogin.html
  
 **InfoHTML** **InfoHTML**
 HTML file for info page display HTML file for info page display
-  -InfoHTML=defaultOffice.html +  * InfoHTML=defaultOffice.html
  
 **HelpSite** **HelpSite**
 Main help documentation URL Main help documentation URL
-  HelpSite=https://help.gitwinch.com/ +  * HelpSite=https://help.gitwinch.com/
  
 **SaaSHelpSite** **SaaSHelpSite**
 Kanban board help site URL Kanban board help site URL
-  SaaSHelpSite=https://help.spoke.today/ +  * SaaSHelpSite=https://help.spoke.today/
  
 ==== Localization ==== ==== Localization ====
Line 107: Line 117:
 **TrLanguage** **TrLanguage**
 Translation language code for translating help. ml stands for Malayalam Translation language code for translating help. ml stands for Malayalam
-  TrLanguage=ml+  * TrLanguage=ml 
 +For the full set of language codes, refer to [[https://cloud.google.com/translate/docs/languages|Google Cloud Translation language codes]]. It is //critical// that the translations file //must// be present for the configured language. In the above example; you MUST have the file //ml.translations.txt// in the //translations// folder present inside the application folder.
  
 +**Note:** Ensure all folder paths exist and you should be able to save here before starting the application.
  
-===== Configuration Steps =====+-----
  
-  - Locate the Git Winch gitwinch.ini file in the application folder 
-  - Open the file in any text editor 
-  - Modify the required settings according to your environment 
-  - Save the file 
-  - Launch Git Winch application 
- 
-**Note:** Ensure all folder paths exist and have appropriate permissions before starting the application. 
- 
------ 
 [[/concepts?do=export_xhtml | Learn the concepts]] | [[/configuration?do=export_xhtml|Configuration]] | [[/advantages?do=export_xhtml | Advantages]] | [[/tsManage2?do=export_xhtml|Management]]  | [[ /advanced?do=export_xhtml | Advanced uses]] | [[ /troubleshooting?do=export_xhtml | Troubleshooting ]] | [[/topics?do=export_xhtml | Table of Contents]] [[/concepts?do=export_xhtml | Learn the concepts]] | [[/configuration?do=export_xhtml|Configuration]] | [[/advantages?do=export_xhtml | Advantages]] | [[/tsManage2?do=export_xhtml|Management]]  | [[ /advanced?do=export_xhtml | Advanced uses]] | [[ /troubleshooting?do=export_xhtml | Troubleshooting ]] | [[/topics?do=export_xhtml | Table of Contents]]
inifile.1749807366.txt.gz · Last modified: by cherin

Page Tools