summaryrefslogtreecommitdiff
path: root/docs/WIN32.txt
blob: c9035dfd0251d304a0c9c3f15edb98c5d0a53219 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
Anope for Windows
-----------------

1) Building the Source
2) Installation
3) Compiling Modules
4) Other compile options
5) Credits

1) Building the Source

    NOTE: If you have downloaded one of the pre-compiled installers, you do
          NOT need to complete this step, and you can proceed to step 2.

    If you want to build Anope from source on a Win32 system, you will need
    to follow this instructions:

    1) Download the required files:

        * Current Anope source:
            http://sourceforge.net/project/showfiles.php?group_id=94081

        * CMake:
            http://www.cmake.org/cmake/resources/software.html

        (NOTE: When installing, tell CMake to add itself to the PATH.)

        If you have Visual C++ 6, 7 (.NET 2002/2003), 8 (2005), or 9 (2008) skip ahead to step 2, else you
        need to download the following free components from Microsoft. Once
        downloaded, install these packages.

        * Microsoft Visual C++ 2008 Express Edition:
            http://www.microsoft.com/express/vc/

        or

        * Microsoft Visual C++ 2005 Express Edition:
            http://www.microsoft.com/downloads/details.aspx?FamilyId=7B0B0339-613A-46E6-AB4D-080D4D4A8C4E&displaylang=en

        then download and install:

        * Microsoft Windows 2008 SDK:
            http://www.microsoft.com/downloads/details.aspx?FamilyId=E6E1C3DF-A74F-4207-8586-711EBE331CDC&displaylang=en

        or (if you prefer a smaller download)

        * Microsoft Windows 2003 Platform SDK: (Requires WGA validation)
            http://www.microsoft.com/downloads/details.aspx?FamilyId=0BAF2B35-C656-4969-ACE8-E4C0C0716ADB&displaylang=en

        (NOTE: Although they say for Windows Server 2003 or 2008, they do infact work on all supported
        versions of Windows. When installing the 2003 SDK, you should select the Custom option, and only select
        to have the Microsoft Windows Core SDK installed. When installing the 2008 SDK, you should select the
        Custom option, and only select to have the Developer Tools installed, but also expand that and deselect
        the Visual C++ Compilers as well as the Mobile Tools. Doing this will decrease the install time as well
        as the space used by the SDK.)

        If you chose to download the 2003 SDK, it will not work out-of-the-box on either Visual C++ 2005 Express or
        Visual C++ 2008 Express. The 2008 SDK will work out-of-the-box with Visual C++ 2008 Express but not with
        Visual C++ 2005 Express.

    2) Unpack the Anope tarball with your favorite uncompression program
       (WinZip or WinRAR, etc).

    3) (Note before this step: If you fall under one of the situations at the end of Step 1 where it says that the
       SDK will not work out of the box, do not bring up the Visual C++ Command Prompt by using the link in
       the Windows Start Menu. Instead, edit vsvars32.bat in the directory where you unpacked the source code
       in step 2, so the first line that says "@SET VSINSTALLDIR=<whatever>" has the directory where you installed
       Visual C++ Express to, if different from the default. Save the file and then run it instead.)

       Bring up the Visual C++ Command Prompt; This will launch a
       DOS Command Prompt like window, which will set the environment
       properties needed to make Anope.

       Create a new directory, which will be used to hold the build files. You can make it
       be a directory under the source directory unpacked in step 2, or somewhere else entirely.

       Change directories to this new folder, by typing:

          cd <path to build directory>

          e.g.

          cd c:\anope-build

    4) You now need to configure Anope to your requirements. At the prompt type:

        <path to source directory>\Config.bat

       NOTE: If you run an Anti-Virus program such as McAfee or Norton, you may
       be unable to run this command due to the protection in place. Some Anti-
       Virus programs may detect the Anope Configuration Tool as a worm, however
       this is not the case. If you are prompted to allow or deny execution of
       the script, you should choose allow. If the script fails to run, and no
       notice is displayed, please check your Anti-Virus settings before seeking
       assistance.

       An interactive configuration program should guide you through the install
       options. You will be given a choice to use NMake or not. NMake will compile
       inside the command prompt window you are in. If you want to build within
       the Visual C++ IDE, say no to that option, and it'll create a Solution for
       you to open up.

       If you cannot find whats causing the error, please visit our forums or
       our IRC Support channel for assistance.

    5) You are now ready to compile. If you said you wanted to use NMake in step 4,
       at the prompt type:

        nmake

       Once you are back at the command prompt again, if there have been no
       errors, you are ready to go.

       If instead you decided to use the Visual C++ IDE, open up the Anope.sln
       file. After the IDE has fully loaded, hit F7 to build everything.

       Should you encounter errors with the installation process, check the
       messages displayed for advice on resolving them. If you are unable to
       resolve the issues yourself, seek assistance on our forums or in our
       IRC Support channel.

    6) Finally you will need to install Anope. If you said you wanted to use NMake
       in step 4, at the prompt type:

        nmake install

       Otherwise, if you decided to use the Visual C++ IDE, find the project called
       INSTALL within the Solution Explorer. Right-click on INSTALL and choose Build.

       When you have done this, all the files will be installed to where they belong.
       The only thing you need to do is rename "data/example.conf" to be "data/services.conf",
       and then follow the steps to set up Anope.

    You have now completed the building phase of Anope for Windows. You can
    now move on to the next section, which is related to setting up Anope.

2) Installation

    Since Anope for Windows does not use a visual interface, you must do the
    configuration with a text editor before proceeding with running Anope
    itself.

    NOTE: You may need to open the configuration file with Wordpad, or a text
    editor which supports UNIX line endings. Opening the configuration file in
    Notepad will cause strange characters to appear, and you may not be able to
    edit the file correctly.

    Open services.conf, and read through it carefully and adjust the settings
    you think you need to adjust. Pay special attention to these settings:

    A) IRCDModule:   This is the name of an IRCd Module that Anope will use
                     to communicate with your server. Anope supports 15 IRCds,
                     so ensure you set the right value here.
    B) RemoteServer: This is the address to your ircd, along with the port
                     and password. You should consult your ircd
                     documentation on how to link ircds.
    C) ServicesRoot: Remove the # and change the names to your nick so you
                     can take control of services once they are online.
    D) UserKey1/2/3: Remove the # infront of the three UserKey settings, and
                     change the parameters to numbers; around 6-7 digits will
                     do.

    If you are unsure of the settings, you can go to the dos command prompt
    and run "anope.exe -nofork -debug" and watch the information as it
    attempts to connect.

    You can launch services in two ways. If you are sure that the entered
    configuration information is correct, simply double clicking the Anope
    executable will cause it to start; no window will pop up. If you'd rather
    have a more textual output, you can start at the dos prompt and type in
    "anope.exe". If services are successfully started up the dos prompt will
    seem to hang; at this point you can safely close the dos window.

3) Compiling Modules

    If you want to build other modules than the ones shipped by default, you
    will need to modify the Makefile.inc.win32 file, in the src\modules folder.

    A) Add modules; find the line stating "SRCS=" and add the name of the
       file to the end of the line. So if you have two files:

        SRCS=file.c file2.c

       If you are compiling a folder of module components, such as the example
       "catserv", you will need to add/change the "SUBS=" line. If you were
       compiling the "catserv" example, the line would look like this:

        SUBS=catserv

    B) When you've done this, use the same command prompt you set up in part
       1, change directories to the src\modules folder, and type:

        nmake -f Makefile.win32

       followed afterwards, by:

        nmake -f Makefile.win32 install

    C) You should now be able to load your modules on IRC via OperServ, or via
       the services.conf file.


4) Other compile options

    A) If you have trouble recompiling Anope, you should delete all files and folders
       within the build folder you created in step 3 of section 1. Afterwards, follow
       the directions from step 4 of section 1 down.

5) Credits

    Anope is based on Epona and IRCServices. See CREDITS for more credits and
    a complete list of all developers.

    Anope's Windows-specific code is provided by:

        * Dominick Meglio       <codemastr@unrealircd.com>
        * Trystan Scott Lee     <trystan@nomadirc.net>
        * Chris Hogben          <heinz@anope.org>

    Anope's Windows Installer was made using:

        * NSIS 2.20          <http://nsis.sourceforge.net>