Blob

Date:
Message:
Please the HTML validator, and perform some other minor markup tweaks.
Actions:
History | Blame | Raw File
1 <!doctype html>

2 <html lang=en>

3 <meta charset=utf-8>

5 <title>Game of Trees Installation Instructions</title>

6 <meta name="description" content="Game of Trees Manual Pages">

7 <meta name="viewport" content="width=device-width, initial-scale=1">

8 <link rel="stylesheet" type="text/css" href="openbsd.css">

9 <link rel="canonical" href="https://gameoftrees.org/install.html">

11 <h2>

12 <a href="index.html">

13 <i>Game of Trees</i></a>

14 Installation Instructions

15 </h2>

16 <hr>

18 <p>

19 These installation instruction apply to the OpenBSD version of Game of Trees.

20 See the <a href="portable.html">portable version</a> for installation

21 instructions which apply to other operating systems.

23 <p>

24 Game of Trees can be installed on OpenBSD with:

26 <pre class="cmdbox">

27 pkg_add got

28 </pre>

30 <p>

31 Alternatively, compile the <code>devel/got</code> port:

33 <p>

34 <pre class="cmdbox">

35 cd /usr/ports/devel/got

36 make

37 make SUDO=doas install

38 </pre>

40 <p>

41 The installation includes:

43 <ul>

44 <li>The <code>got</code> command line interface

45 <li>The <code>tog</code> repository browser

46 <li>Several <a href="manual.html">manual pages</a>

47 <li>Helper programs in the <code>/usr/local/libexec</code> directory:

48 <ul>

49 <li>

50 <code>got-fetch-pack</code>,

51 <code>got-index-pack</code>,

52 <code>got-read-blob</code>,

53 <code>got-read-commit</code>,

54 <code>got-read-gitconfig</code>,

55 <code>got-read-gotconfig</code>,

56 <code>got-read-object</code>,

57 <code>got-read-pack</code>,

58 <code>got-read-patch</code>,

59 <code>got-read-tag</code>,

60 <code>got-read-tree</code>,

61 <code>got-send-pack</code>

62 </ul>

63 </ul>

65 As a post-installation step the <code><var>GOT_AUTHOR</var></code> environment

66 variable should be set:

67 <p>

68 <pre class="cmdbox">

69 export GOT_AUTHOR='Flan Hacker &lt;flan_hacker@openbsd.org&gt;'

70 </pre>

72 <p>

73 On OpenBSD -current, and OpenBSD 7.3 release or later, the

74 Game of Trees Git repository server can be installed with:

76 <pre class="cmdbox">

77 pkg_add gotd

78 </pre>

80 Alternatively, the -server subpackage of the port can be built:

81 <pre class="cmdbox">

82 cd /usr/ports/devel/got

83 env SUBPACKAGE=-server make

84 env SUBPACKAGE=-server doas make install

85 </pre>

87 <p>

88 The server installation includes:

90 <ul>

91 <li>The <code>gotd</code> daemon

92 <li>The <code>gotsh</code> network-facing frontend for the daemon

93 <li>The <code>gotctl</code> control utility

94 </ul>

96 Setup instructions are provided in the

97 <a href="gotd.8.html">gotd</a>,

98 <a href="gotsh.1.html">gotsh</a>, and

99 <a href="gotd.conf.5.html">gotd.conf</a> manual pages.

101 <p>

102 The repository web frontend <code>gotwebd</code> can likewise be

103 installed from packages:

105 <pre class="cmdbox">

106 pkg_add gotwebd

107 </pre>

109 Alternatively, the -webd subpackage of the port can be built:

110 <pre class="cmdbox">

111 cd /usr/ports/devel/got

112 env SUBPACKAGE=-webd make

113 env SUBPACKAGE=-webd doas make install

114 </pre>

116 Setup instructions are provided in the

117 <a href="gotwebd.8.html">gotwebd</a> manual page.