INSTALL

   1 newserv Installation
   2 ~~~~~~~~~~~~~~~~~~~
   3
   4 In order to install newserv you will have to run the configure script:
   5
   6 $ ./configure
   7
   8 The configure script will list any missing dependencies. If you're unsure why
   9 a certain library or header file was not found you can run the configure script
  10 with the -v option or check the .configure.log file after your first configure
  11 run.
  12
  13 Please refer to the "Local Settings" section in this file if you're
  14 using non-standard library/header search paths. Once you've resolved all
  15 dependency issues you can build newserv:
  16
  17 $ make
  18
  19 This might take a while. After all modules are built you can install
  20 newserv:
  21
  22 $ make install
  23
  24 By default the newserv binary and the modules are installed into your
  25 source tree. The recommended setup is to now create a separate directory
  26 and symlink the "newserv" binary and the "modules" directory into it:
  27
  28 $ cd
  29 $ mkdir newserv-install && cd newserv-install
  30 $ mkdir data # Some modules depend on this directory being available
  31 $ ln -s ../newserv-src/newserv
  32 $ ln -s ../newserv-src/modules
  33
  34 You will also need to copy the newserv.conf.example configuration file to your
  35 installation directory and rename it to newserv.conf.
  36
  37 After you have updated your newserv.conf file you can start newserv:
  38
  39 $ ./newserv
  40
  41 newserv does not detach from the console. Consider running it in a
  42 screen(1) session.
  43
  44 Local Settings
  45 ~~~~~~~~~~~~~
  46
  47 If you are using non-standard library/include paths you can create a file
  48 called configure.ini.local (using configure.ini.local.example as a template)
  49 to override some of the settings.
  50
  51 Workspaces
  52 ~~~~~~~~~
  53
  54 If you're planning to write your own modules you might consider using
  55 workspace.
  56
  57 For this to work you will need to create a directory for your modules:
  58
  59 $ mkdir custom
  60
  61 Create a skeleton configure.ini in your new module directory:
  62
  63 [modules]
  64 mymodule=
  65
  66 And finally add your workspace to the workspaces.ini file:
  67
  68 [workspaces]
  69 custom=
  70
  71 You will need to re-run configure for it to pick up your new
  72 workspace and whatever modules you have in it.