Mercurial > hg > rlgwebd

comparison README.txt @ 209:2667aaad8e08

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Move the NODE_PATH location. Modules are now expected to be in /var/local/lib/node_modules. This is intended to make it easier to avoid running npm as root.
author John "Elwin" Edwards
date Tue, 26 Dec 2017 13:23:55 -0500
parents 34e1bc4fd6b2
children b04313038a0b
comparison
equal deleted inserted replaced
208:f06f2d1a5035 209:2667aaad8e08
6 Node 6 Node
7 --- 7 ---
8 RLGWebD currently works with Node v0.10. 8 RLGWebD currently works with Node v0.10.
9 9
10 It requires the 'posix', 'pty.js', and 'websocket' modules. Currently, 10 It requires the 'posix', 'pty.js', and 'websocket' modules. Currently,
11 it expects them to be installed in the global location, which is 11 it expects them to be installed in "/var/local/lib/node_modules". It
12 "/usr/lib/node_modules". It is planned to eventually use a different 12 is not recommended to run npm as root when installing the modules.
13 location so that npm will not need to run as root.
14 13
15 init 14 init
16 --- 15 ---
17 RLGWebD now includes a systemd unit file, which is the recommended way 16 RLGWebD now includes a systemd unit file, which is the recommended way
18 to run it. See below for more instructions. 17 to run it. See below for more instructions.
20 For other init systems, a shell script is provided. This is not really 19 For other init systems, a shell script is provided. This is not really
21 a proper initscript, but it could form the basis of one. 20 a proper initscript, but it could form the basis of one.
22 21
23 Configuration 22 Configuration
24 --- 23 ---
25 You can set some options by changing some variables in the first few 24 A configuration file is installed at /etc/rlgwebd.conf. It contains a
26 lines of the rlgwebd script: 25 list of options.
27 26
28 Option Variable Default 27 If the domain_name option and the SSL-related options are set, rlgwebd
29 28 will use HTTPS instead of insecure HTTP.
30 Chroot path chrootDir /var/dgl
31 Username dropToUser rodney
32 Server port httpPort 8080
33 29
34 If you change the chroot location, change it in the first line of the 30 If you change the chroot location, change it in the first line of the
35 Makefile too. 31 Makefile too.
36 32
37 Installation 33 Installation
57 Running "make install" will: 53 Running "make install" will:
58 Copy the Web assets into the chroot 54 Copy the Web assets into the chroot
59 Copy the C programs and the libraries they need into the chroot 55 Copy the C programs and the libraries they need into the chroot
60 Install the main RLGWebD script in /usr/local/bin 56 Install the main RLGWebD script in /usr/local/bin
61 Place the systemd unit file in the proper directory 57 Place the systemd unit file in the proper directory
58 Copy a configuration file into /etc
62 59
63 If you don't use systemd, or want to change the installation locations, 60 If you don't use systemd, or want to change the installation locations,
64 you will have to edit the Makefile. 61 you will have to edit the Makefile.
65 62
66 You will still need to run "systemctl enable rlgwebd" to make the 63 You will still need to run "systemctl enable rlgwebd" to make the