aboutsummaryrefslogtreecommitdiff
path: root/docs_src/installation.md
blob: f19c4e0a839030b62bf32a60273f269d44b67fc3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

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)"
}

Starting

You can now run Githermit with $ yarn start