]>
Commit | Line | Data |
---|---|---|
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 using | |
14 | non-standard library/header search paths. Once you've resolved all dependency | |
15 | issues you can build newserv: | |
16 | ||
17 | $ make | |
18 | ||
19 | This might take a while. After all modules are built you can install newserv: | |
20 | ||
21 | $ make install | |
22 | ||
23 | By default the newserv binary and the modules are installed into your source | |
24 | tree. The recommended setup is to now create a separate directory and symlink | |
25 | the "newserv" binary and the "modules" directory into it: | |
26 | ||
27 | $ cd | |
28 | $ mkdir newserv-install && cd newserv-install | |
29 | $ ln -s ../newserv-src/newserv | |
30 | $ ln -s ../newserv-src/modules | |
31 | ||
32 | You will also need to copy the newserv.conf.example configuration file to your | |
33 | installation directory and rename it to newserv.conf. The MODULES file has a | |
34 | list of available modules and their configuration settings. | |
35 | ||
36 | After you have updated your newserv.conf file you can start newserv: | |
37 | ||
38 | $ ./newserv | |
39 | ||
40 | newserv does not detach from the console. Consider running it in a | |
41 | screen(1) session. | |
42 | ||
43 | User Accounts | |
44 | ~~~~~~~~~~~~ | |
45 | ||
46 | You can create a user on your control instance using /msg N hello (where N is | |
47 | the nick of your control user). You need to be opered and authed in order to | |
48 | use this command. | |
49 | ||
50 | If your network does not have an authentication service that supports account | |
51 | IDs you can load the "auth" module. Note that this module lets opers set | |
52 | arbitrary account names and IDs and therefore should probably not be loaded on | |
53 | production networks. | |
54 | ||
55 | Once you have an account you should have a look at /msg N showcommands for a | |
56 | list of available commands. | |
57 | ||
58 | Local Settings | |
59 | ~~~~~~~~~~~~~ | |
60 | ||
61 | If you are using non-standard library/include paths you can create a file | |
62 | called configure.ini.local (using configure.ini.local.example as a template) to | |
63 | override some of the settings. | |
64 | ||
65 | Workspaces | |
66 | ~~~~~~~~~ | |
67 | ||
68 | If you're planning to write your own modules you might consider using | |
69 | workspaces. | |
70 | ||
71 | For this to work you will need to create a directory for your modules: | |
72 | ||
73 | $ mkdir custom | |
74 | ||
75 | Create a skeleton configure.ini in your new module directory: | |
76 | ||
77 | [modules] | |
78 | mymodule= | |
79 | ||
80 | And finally add your workspace to the workspaces.ini file: | |
81 | ||
82 | [workspaces] | |
83 | custom= | |
84 | ||
85 | You will need to re-run configure for it to pick up your new workspace and | |
86 | whatever modules you have in it. |