Chroot jail - Revision history

Aximili: Add man page link

2020-03-20T04:21:54Z

Add man page link

86.135.188.145: blank lines break lists

2012-08-05T17:53:14Z

blank lines break lists

220.255.1.158 at 17:25, 5 August 2012

2012-08-05T17:25:15Z

Tjr: note that

2011-08-31T20:13:01Z

note that

Cilona at 20:19, 7 April 2008

2008-04-07T20:19:01Z

Paxed: Basically: How to compile NetHack for public server usage

2008-04-07T19:55:05Z

Basically: How to compile NetHack for public server usage

New page

{{wikipedia|chroot jail}}

'''chroot jail''' is a way of running programs on [[unix]] operating systems so that the program cannot access anything outside the "jail" directory. This article describes how to compile NetHack so it can be used inside a chroot jail; this is useful when you want to run a [[public server]]. Usually you also need a wrapper program that handles user logins; one such program is [[dgamelaunch]].

*First, [[compile]] NetHack as documented in the Linux TTY-section.

*Edit <tt>include/config.h</tt> and change <tt>HACKDIR</tt> to <tt>"/nh343"</tt> (Note that there are more than one definition of HACKDIR in there!)

*Edit <tt>include/unixconf.h</tt>: enable <tt>VAR_PLAYGROUND</tt> and change it's value to <tt>"/nh343/var"</tt>

*Edit the top Makefile:

**Comment out all lines that reference <tt>$SHELLDIR</tt>. We don't need to install the shellscript that is usually used to launch NetHack.

**Change <tt>PREFIX</tt> to the directory which will be the chroot environment and contain all the files the server needs. We'll be using <tt>"/opt/nethack/nethack.alt.org"</tt> here as an example.

**Change <tt>GAMEDIR</tt> to <tt>$(PREFIX)/nh343</tt>

**Change <tt>VARDIR</tt> to <tt>$(GAMEDIR)/var</tt>

**Change <tt>GAMEUID</tt> and <tt>GAMEGRP</tt> to the user and group you will run nethack as; the default [[dgamelaunch]] settings for these are <tt>games</tt> and <tt>games</tt>.

*Create the binaries with <tt>make all</tt>. If things went smoothly, do <tt>make install</tt> (or <tt>make update</tt> if you've already installed NetHack once to the chroot dir)

*do <tt>ldd src/nethack</tt> to see what dynamic link libraries the binary needs. Copy those into <tt>/opt/nethack/nethack.alt.org/lib/</tt>

*Find where your terminfo files are (usually in <tt>/usr/share/terminfo</tt>, <tt>/etc/terminfo</tt> or <tt>/usr/share/lib/terminfo</tt>). In the chroot directory, create a similar directory structure. For example, let's say the terminfo files are in <tt>/usr/share/terminfo</tt>; you would create directory <tt>"/opt/nethack/nethack.alt.org/lib/usr/share/terminfo"</tt>. Note that there could be different terminfo files in different directories; do this for all of the terminfo files.

*Copy all the terminfo files into their directories you created in the chroot, maintaining the directory structure of the terminfo files.

*Test that you can run the NetHack inside the chroot environment, by doing the following as root:
cd /opt/nethack/nethack.alt.org
chroot ./ nh343/nethack

**If NetHack doesn't start but you get a complaint about missing file or directory:
chroot: cannot run command `nh343/nethack': No such file or directory
That usually means the binary is missing some dynamic link library from the chroot.

**If you get a complaint about unknown terminal type, that means there's some problem with the terminfo files. Check that there is a terminfo file that corresponds to your <tt>$TERM</tt> setting.

[[Category:Development]]

← Older revision		Revision as of 04:21, 20 March 2020
Line 1:		Line 1:
	{{wikipedia\|chroot jail}}		{{wikipedia\|chroot jail}}
		+	{{man\|chroot}}

	'''chroot jail''' is a way of running programs on [[Unix]] operating systems so that the program cannot access anything outside the "jail" directory. This article describes how to compile NetHack so it can be used inside a chroot jail; this is useful when you want to run a [[public server]]. Usually you also need a wrapper program that handles user logins; one such program is [[dgamelaunch]].		'''chroot jail''' is a way of running programs on [[Unix]] operating systems so that the program cannot access anything outside the "jail" directory. This article describes how to compile NetHack so it can be used inside a chroot jail; this is useful when you want to run a [[public server]]. Usually you also need a wrapper program that handles user logins; one such program is [[dgamelaunch]].

@@ Line 5: / Line 5: @@
 *First, [[compile]] NetHack as documented in the Linux TTY-section.
-*Edit <tt>include/config.h</tt> and change <tt>HACKDIR</tt> to <tt>"/nh343"</tt> (Note that there is more than one definition of HACKDIR in there!)
+*Edit <tt>include/config.h</tt> and change <tt>HACKDIR</tt> to <tt>"/nh343"</tt> (There is more than one definition of HACKDIR in there!)
 *Edit <tt>include/unixconf.h</tt>: enable <tt>VAR_PLAYGROUND</tt> and change its value to <tt>"/nh343/var"</tt>
@@ Line 25: / Line 25: @@
 *do <tt>ldd src/nethack</tt> to see what dynamic link libraries the binary needs. Copy those into <tt>/opt/nethack/nethack.alt.org/lib/</tt>
-*Find where your terminfo files are (usually in <tt>/usr/share/terminfo</tt>, <tt>/etc/terminfo</tt> or <tt>/usr/share/lib/terminfo</tt>). In the chroot directory, create a similar directory structure. For example, let's say the terminfo files are in <tt>/usr/share/terminfo</tt>; you would create directory <tt>"/opt/nethack/nethack.alt.org/lib/usr/share/terminfo"</tt>. Note that there could be different terminfo files in different directories; do this for all of the terminfo files.
+*Find where your terminfo files are (usually in <tt>/usr/share/terminfo</tt>, <tt>/etc/terminfo</tt> or <tt>/usr/share/lib/terminfo</tt>). In the chroot directory, create a similar directory structure. For example, let's say the terminfo files are in <tt>/usr/share/terminfo</tt>; you would create directory <tt>"/opt/nethack/nethack.alt.org/lib/usr/share/terminfo"</tt>. There could be different terminfo files in different directories; do this for all of the terminfo files.
 *Copy all the terminfo files into their directories you created in the chroot, maintaining the directory structure of the terminfo files.

@@ Line 2: / Line 2: @@
 '''chroot jail''' is a way of running programs on [[Unix]] operating systems so that the program cannot access anything outside the "jail" directory.  This article describes how to compile NetHack so it can be used inside a chroot jail; this is useful when you want to run a [[public server]]. Usually you also need a wrapper program that handles user logins; one such program is [[dgamelaunch]].
 *First, [[compile]] NetHack as documented in the Linux TTY-section.
 *Edit <tt>include/config.h</tt> and change <tt>HACKDIR</tt> to <tt>"/nh343"</tt> (There is more than one definition of HACKDIR in there!)
 *Edit <tt>include/unixconf.h</tt>: enable <tt>VAR_PLAYGROUND</tt> and change its value to <tt>"/nh343/var"</tt>
 *Edit the top Makefile:
 **Comment out all lines that reference <tt>$SHELLDIR</tt>. We don't need to install the shellscript that is usually used to launch NetHack.
 **Change <tt>PREFIX</tt> to the directory which will be the chroot environment and contain all the files the server needs. We'll be using <tt>"/opt/nethack/nethack.alt.org"</tt> here as an example.
 **Change <tt>GAMEDIR</tt> to <tt>$(PREFIX)/nh343</tt>
 **Change <tt>VARDIR</tt> to <tt>$(GAMEDIR)/var</tt>
 **Change <tt>GAMEUID</tt> and <tt>GAMEGRP</tt> to the user and group you will run nethack as; the default [[dgamelaunch]] settings for these are <tt>games</tt> and <tt>games</tt>.
 *Create the binaries with <tt>make all</tt>. If things went smoothly, do <tt>make install</tt> (or <tt>make update</tt> if you've already installed NetHack once to the chroot dir)
 *do <tt>ldd src/nethack</tt> to see what dynamic link libraries the binary needs. Copy those into <tt>/opt/nethack/nethack.alt.org/lib/</tt>
 *Find where your terminfo files are (usually in <tt>/usr/share/terminfo</tt>, <tt>/etc/terminfo</tt> or <tt>/usr/share/lib/terminfo</tt>). In the chroot directory, create a similar directory structure. For example, let's say the terminfo files are in <tt>/usr/share/terminfo</tt>; you would create directory <tt>"/opt/nethack/nethack.alt.org/lib/usr/share/terminfo"</tt>. There could be different terminfo files in different directories; do this for all of the terminfo files.
 *Copy all the terminfo files into their directories you created in the chroot, maintaining the directory structure of the terminfo files.
 *Test that you can run the NetHack inside the chroot environment, by doing the following as root:
   cd /opt/nethack/nethack.alt.org
   chroot ./ nh343/nethack
+:*If NetHack doesn't start but you get a complaint about missing file or directory:
   chroot: cannot run command `nh343/nethack': No such file or directory
-That usually means the binary is missing some dynamic link library from the chroot.
+::That usually means the binary is missing some dynamic link library from the chroot.
+:*If you get a complaint about unknown terminal type, that means there's some problem with the terminfo files. Check that there is a terminfo file that corresponds to your <tt>$TERM</tt> setting.
 [[Category:Development]]

@@ Line 1: / Line 1: @@
 {{wikipedia|chroot jail}}
-'''chroot jail''' is a way of running programs on [[unix]] operating systems so that the program cannot access anything outside the "jail" directory.  This article describes how to compile NetHack so it can be used inside a chroot jail; this is useful when you want to run a [[public server]]. Usually you also need a wrapper program that handles user logins; one such program is [[dgamelaunch]].
+'''chroot jail''' is a way of running programs on [[Unix]] operating systems so that the program cannot access anything outside the "jail" directory.  This article describes how to compile NetHack so it can be used inside a chroot jail; this is useful when you want to run a [[public server]]. Usually you also need a wrapper program that handles user logins; one such program is [[dgamelaunch]].
 *First, [[compile]] NetHack as documented in the Linux TTY-section.