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. The MODULES file
  36 has a list of available modules.
  37
  38 After you have updated your newserv.conf file you can start newserv:
  39
  40 $ ./newserv
  41
  42 newserv does not detach from the console. Consider running it in a
  43 screen(1) session.
  44
  45 Local Settings
  46 ~~~~~~~~~~~~~
  47
  48 If you are using non-standard library/include paths you can create a file
  49 called configure.ini.local (using configure.ini.local.example as a template)
  50 to override some of the settings.
  51
  52 Workspaces
  53 ~~~~~~~~~
  54
  55 If you're planning to write your own modules you might consider using
  56 workspace.
  57
  58 For this to work you will need to create a directory for your modules:
  59
  60 $ mkdir custom
  61
  62 Create a skeleton configure.ini in your new module directory:
  63
  64 [modules]
  65 mymodule=
  66
  67 And finally add your workspace to the workspaces.ini file:
  68
  69 [workspaces]
  70 custom=
  71
  72 You will need to re-run configure for it to pick up your new
  73 workspace and whatever modules you have in it.