Skip to main content

Steps to Install git-remote-gitopia(Windows)

You need to install git-remote-gitopia helper so that your git command line can understand gitopia:// transport. Windows users should follow the steps below to get started.

Steps​

  1. Open Windows Explorer.
  2. Create a new folder: C:\Gitopia, assuming you want Gitopia on your C drive, although this can go anywhere.
  3. Create a subfolder in the Gitopia folder: C:\Gitopia\bin.
  4. Download the latest zipped git-remote-gitopia executable.
  5. Extract all contents to C:\Gitopia\bin folder.
  6. Add C:\Gitopia\bin to PATH.

Adding git-remote-gitopia and git-gitopia binary to PATH​

Method 1: PowerShell/CMD​

In PowerShell or your preferred CLI, add the git-remote-gitopia.exe executable to your PATH by navigating to C:\Gitopia\bin (or the location of your git-remote-gitopia.exe and git-gitopia.exe files) and use the following command.

set PATH=%PATH%;C:\Gitopia\bin

If the git-remote-gitopia command does not work, you may have to run the command prompt as administrator.

Method 2: Graphical User Interface​

  1. Right-click on the Start button.
  2. Click on System.
  3. Click on Advanced System Settings on the left.
  4. Click on the Environment Variables… button at the bottom.
  5. In the User variables section, find the row that starts with PATH (PATH will be in all caps).
  6. Double-click on PATH.
  7. Click the New… button.
  8. Type in the folder where git-remote-gitopia.exe and git-gitopia.exe were extracted, which is C:\Gitopia\bin if you followed the instructions above. The PATH entry should be the directory where the executables exist and not the executable path. Press Enter when you’re done typing. Click OK at every window to exit.

Verify the installation​

Run the following command in a Command Prompt or PowerShell

git-remote-gitopia

You should see a similar output.

2021/09/29 09:29:35 Usage: git-remote-gitopia remote-name url

If you do, then the installation is complete. If you don’t, double-check the path where you placed the git-remote-gitopia.exe executable and the one you typed when you updated your PATH variable.

Usage​

git-remote-gitopia will be implicitly called when git encounters gitopia:// remote.

For pushing git repositories to Gitopia, you would require a Gitopia wallet with sufficient tokens and you need to configure the wallet for git-remote-gitopia. git-remote-gitopia currently supports the following wallets.

danger

We recommend that you keep a separate wallet, added as a collaborator, for authorizing wallet and pushing your code. Don't use your main wallet and keep it safe.

The OS keyring uses the Windows Credential Manager to store the keys securely. This is the recommended way to store your Gitopia keys on Windows. Follow the steps below to configure git to use your key from OS keyring. Follow the steps here to use OS Keyring to push your commits to Gitopia.

Gitopia Wallet​

You can download the Gitopia wallet from the webapp. Set an environment variable GITOPIA_WALLET with the path of your wallet file. Follow the steps here to set up a Gitopia wallet to push your commits to Gitopia.

Ledger Hardware Wallet​

git-remote-gitopia also supports Ledger Hardware Wallet. Follow the steps here to install the Cosmos (ATOM) app. Connect your ledger and open the Cosmos (ATOM) when you git push.

note

You will get prompted to sign the transaction two times. The first transaction is for generating offchain signature to authenticate with git server, this transaction is not broadcasted to the chain and is not a valid chain transaction. The second transaction is the actual transaction to update the repository state on the Gitopia chain.

danger

Keep your wallet file secure and do not share it with anyone.