Skip to content

Latest commit

 

History

History
46 lines (33 loc) · 1.19 KB

installation.md

File metadata and controls

46 lines (33 loc) · 1.19 KB

Requirements

Githermit needs a multitude of packages to work properly.

You'll need to have Git installed (obviously). You should be able to simply install this with your package manager.
For example:

# apt-get install git

Githermit also requires NodeJS. You can find a comprehensive guide on how to install it in the NodeJS documentation.

And then there's a couple of packages that may or may not already be installed on your system.

  • gpg
  • libpcre
  • libpcreposix
  • libkrb5
  • libk5crypto
  • libcom_err
  • libssl-dev

Setup

You should now install the Javascript dependencies with Yarn.

$ yarn install

And finally, build the project.

$ yarn build

The final step is to create a file called settings.json with the following content.

{
	"host": "(Host address)",
	"port": (Port),
	"title": "(Title of your Githermit instance)",
	"about": "(Short description of your Githermit instance)",
	"git_dir: "(Directory where all of your bare Git repositories are located)"
}

You can find more in-depth information about configuring Githermit in configuring.

Starting

You can now run Githermit with $ yarn start