summaryrefslogtreecommitdiffstats
path: root/usr/local/www/wizards/setup_wizard.xml
blob: 1cf882cb72ee6a7807a7ae9251c3e342aea20f81 (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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
<?xml version="1.0" encoding="utf-8" ?>
<pfsensewizard>
<copyright>
/* $Id$ */
/*
	setup.xml
        part of pfSense (http://www.pfsense.org/)

	Copyright (C) 2004, 2005 Scott Ullrich
        All rights reserved.

        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:

        1. Redistributions of source code must retain the above copyright notice,
           this list of conditions and the following disclaimer.

        2. Redistributions in binary form must reproduce the above copyright
           notice, this list of conditions and the following disclaimer in the
           documentation and/or other materials provided with the distribution.

        THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
        INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
        AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
        AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
        OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
        SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
        INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
        CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
        ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
        POSSIBILITY OF SUCH DAMAGE.
*/
</copyright>
<totalsteps>9</totalsteps>
<step>
	<id>1</id>
	<title>pfSense Setup Wizard</title>
	<disableheader>true</disableheader>
	<description>This wizard will guide you through the initial configuration of pfSense.</description>
	<fields>
		<field>
			<name>Next</name>
			<type>submit</type>
		</field>
	</fields>
	<stepbeforeformdisplay>
		conf_mount_rw();
		unlink_if_exists('/conf/trigger_initial_wizard');
		conf_mount_ro();
	</stepbeforeformdisplay>
</step>
<step>
	<id>2</id>
	<title>General Information</title>
	<description>On this screen you will set the General pfSense parameters.</description>
	<fields>
		<field>
			<name>Hostname</name>
			<type>input</type>
			<bindstofield>system->hostname</bindstofield>
			<description>EXAMPLE: myserver</description>
		</field>
		<field>
			<name>Domain</name>
			<type>input</type>
			<bindstofield>system->domain</bindstofield>
			<description>EXAMPLE: mydomain.com</description>
			<validate>^[a-z0-9.|-]+$</validate>
			<message>Domain name field is invalid</message>
		</field>
		<field>
			<name>Primary DNS Server</name>
			<type>input</type>
			<bindstofield>system->dnsserver</bindstofield>
			<!-- we must unset the fields because this is an array. -->
			<unsetfield>yes</unsetfield>
			<arraynum>0</arraynum>
		</field>
		<field>
			<name>Secondary DNS Server</name>
			<type>input</type>
			<bindstofield>system->dnsserver</bindstofield>
			<arraynum>1</arraynum>
		</field>
		<field>
			<name>Next</name>
			<type>submit</type>
		</field>
	</fields>
</step>
<step>
	<id>3</id>
	<title>Time Server Information</title>
	<description>Please enter the time, date and time zone.</description>
	<fields>
		<field>
			<name>Time server dns name</name>
			<description>Enter the name of the time server.</description>
			<type>input</type>
			<bindstofield>system->timeservers</bindstofield>
		</field>
		<field>
			<name>Timezone</name>
			<type>timezone_select</type>
			<bindstofield>system->timezone</bindstofield>
		</field>
		<field>
			<name>Next</name>
			<type>submit</type>
		</field>
	</fields>
</step>
<step>
	<id>4</id>
	<disableallfieldsbydefault>true</disableallfieldsbydefault>
	<title>Configure WAN Interface</title>
	<description>On this screen we will configure the Wide Area Network information.</description>
	<javascriptafterformdisplay>
		var selectedItem = 0;
		if(document.forms[0].ipaddress.value == 'dhcp') {
			selectedItem = 1;
			document.forms[0].ipaddress.value = '';
		} else if(document.forms[0].ipaddress.value == 'PPPoE') {
			selectedItem = 2;
			document.forms[0].ipaddress.value = '';
		} else if(document.forms[0].ipaddress.value == 'PPTP') {
			selectedItem = 3;
			document.forms[0].ipaddress.value = '';
		} else if(document.forms[0].ipaddress.value == 'BigPond') {
			selectedItem = 4;
			document.forms[0].ipaddress.value = '';
		} else {
			selectedItem = 0;
		}
		document.forms[0].selectedtype.selectedIndex = selectedItem;
		enableitems(selectedItem);
	</javascriptafterformdisplay>
	<fields>
		<field>
			<name>SelectedType</name>
			<type>select</type>
			<donotdisable>true</donotdisable>
			<options>
				<option>
					<name>Static</name>
					<value>Static</value>
					<enablefields>ipaddress,subnetmask,gateway</enablefields>
				</option>
				<option>
					<name>DHCP</name>
					<value>dhcp</value>
					<enablefields>dhcphostname</enablefields>
				</option>
				<option>
					<name>PPPoE</name>
					<value>pppoe</value>
					<enablefields>pppoeusername,pppoepassword,pppoeservicename,pppoedialondemand,pppoeidletimeout</enablefields>
				</option>
				<option>
					<name>PPTP</name>
					<value>pptp</value>
					<enablefields>pptpusername,pptppassword,pptplocalipaddress,pptplocalsubnet,pptpremoteipaddress,pptpdialondemand,pptpidletimeout
					</enablefields>
				</option>
				<option>
					<name>BigPond</name>
					<value>bigpond</value>
					<enablefields>bigpondusername,bigpondpassword,bigpondauthenticationserver,bigpondauthenticationdomain,bigpondminheartbeatinterval</enablefields>
				</option>
			</options>
		</field>
		<field>
			<name>General configuration</name>
			<type>listtopic</type>
		</field>
		<field>
			<donotdisable>true</donotdisable>
			<name>MAC Address</name>
			<bindstofield>interfaces->wan->spoofmac</bindstofield>
			<type>input</type>
			<description> This field can be used to modify ("spoof") the MAC address of the WAN interface (may be required with some cable connections) Enter a MAC address in the following format: xx:xx:xx:xx:xx:xx or leave blank</description>
		</field>
		<field>
			<donotdisable>true</donotdisable>
			<name>MTU</name>
			<type>input</type>
			<bindstofield>interfaces->wan->mtu</bindstofield>
			<description> If you enter a value in this field, then MSS clamping for TCP connections to the value entered above minus 40 (TCP/IP header size) will be in effect. If you leave this field blank, an MTU of 1492 bytes for PPPoE and 1500 bytes for all other connection types will be assumed.</description>
		</field>
		<field>
			<name>Static IP Configuration</name>
			<type>listtopic</type>
		</field>
		<field>
			<name>IP Address</name>
			<bindstofield>interfaces->wan->ipaddr</bindstofield>
			<type>input</type>
			<typehint> / </typehint>
			<combinefieldsbegin>true</combinefieldsbegin>
		</field>
		<field>
			<combinefieldsend>true</combinefieldsend>
			<dontdisplayname>true</dontdisplayname>
			<dontcombinecells>true</dontcombinecells>
			<name>Subnet Mask</name>
			<bindstofield>interfaces->wan->subnet</bindstofield>
			<type>subnet_select</type>
		</field>
		<field>
			<name>Gateway</name>
			<bindstofield>interfaces->wan->gateway</bindstofield>
			<type>input</type>
		</field>
		<field>
			<name>DHCP client configuration</name>
			<type>listtopic</type>
		</field>
		<field>
			<name>DHCP Hostname</name>
			<type>input</type>
			<bindstofield>interfaces->wan->dhcphostname</bindstofield>
			<description> The value in this field is sent as the DHCP client identifier and hostname when requesting a DHCP lease. Some ISPs may require this (for client identification).</description>
		</field>
		<field>
			<name>PPPoE configuration</name>
			<type>listtopic</type>
		</field>
		<field>
			<name>PPPoE Username</name>
			<type>input</type>
			<bindstofield>pppoe->username</bindstofield>
		</field>
		<field>
			<name>PPPoE Password</name>
			<type>input</type>
			<bindstofield>pppoe->password</bindstofield>
		</field>
		<field>
			<name>PPPoE Service name</name>
			<type>input</type>
			<description>Hint: this field can usually be left empty</description>
		</field>
		<field>
			<name>PPPoE Dial on demand</name>
			<typehint>Enable Dial-On-Demand mode</typehint>
			<type>checkbox</type>
			<description>This option causes the interface to operate in dial-on-demand mode, allowing you to have a virtual full time connection. The interface is configured, but the actual connection of the link is delayed until qualifying outgoing traffic is detected.</description>
		</field>
		<field>
			<name>PPPoE Idle timeout</name>
			<type>input</type>
			<description>If no qualifying outgoing packets are transmitted for the specified number of seconds, the connection is brought down. An idle timeout of zero disables this feature.</description>
		</field>
		<field>
			<name>PPTP configuration</name>
			<type>listtopic</type>
		</field>
		<field>
			<name>PPTP Username</name>
			<type>input</type>
			<bindstofield>pptp->username</bindstofield>
		</field>
		<field>
			<name>PPTP Password</name>
			<type>input</type>
			<bindstofield>pptp->password</bindstofield>
		</field>
		<field>
			<combinefieldsbegin>true</combinefieldsbegin>
			<name>PPTP Local IP Address</name>
			<type>input</type>
			<typehint> / </typehint>
			<bindstofield>pptp->local</bindstofield>
		</field>
		<field>
			<combinefieldsend>true</combinefieldsend>
			<dontdisplayname>true</dontdisplayname>
			<dontcombinecells>true</dontcombinecells>
			<name>pptplocalsubnet</name>
			<bindstofield>pptp->subnet</bindstofield>
			<type>subnet_select</type>
		</field>
		<field>
			<name>PPTP Remote IP Address</name>
			<bindstofield>pptp->remote</bindstofield>
			<type>input</type>
		</field>
		<field>
			<name>PPTP Dial on demand</name>
			<typehint>Enable Dial-On-Demand mode</typehint>
			<type>checkbox</type>
			<description>This option causes the interface to operate in dial-on-demand mode, allowing you to have a virtual full time connection. The interface is configured, but the actual connection of the link is delayed until qualifying outgoing traffic is detected.</description>
		</field>
		<field>
			<name>PPTP Idle timeout</name>
			<type>input</type>
			<description>If no qualifying outgoing packets are transmitted for the specified number of seconds, the connection is brought down. An idle timeout of zero disables this feature.</description>
		</field>
		<field>
			<name>BigPond configuration</name>
			<type>listtopic</type>
		</field>
		<field>
			<name>BigPond Username</name>
			<type>input</type>
			<bindstofield>bigpond->username</bindstofield>
		</field>
		<field>
			<name>BigPond Password</name>
			<type>input</type>
			<bindstofield>bigpond->password</bindstofield>
		</field>
		<field>
			<name>BigPond Authentication server</name>
			<type>input</type>
			<bindstofield>bigpond->authserver</bindstofield>
			<description>If this field is left empty, the default ("dce-server") is used.</description>
		</field>
		<field>
			<name>BigPond Authentication domain</name>
			<type>input</type>
			<bindstofield>bigpond->authdomain</bindstofield>
			<description>If this field is left empty, the domain name assigned via DHCP will be used.  Note: the BigPond client implicitly sets the "Allow DNS server list to be overridden by DHCP/PPP on WAN" on the System: General setup page.</description>
		</field>
		<field>
			<name>BigPond min heartbeat interval</name>
			<type>input</type>
			<typehint>seconds</typehint>
			<bindstofield>bigpond->minheartbeatinterval</bindstofield>
			<description> Setting this to a sensible value (e.g. 60 seconds) can protect against DoS attacks.</description>
		</field>
		<field>
			<name>RFC1918 Networks</name>
			<type>listtopic</type>
		</field>
		<field>
			<donotdisable>true</donotdisable>
			<name>Block RFC1918 Private Networks</name>
			<description> When set, this option blocks traffic from IP addresses that are reserved for private networks as per RFC 1918 (10/8, 172.16/12, 192.168/16) as well as loopback addresses (127/8). You should generally leave this option turned on, unless your WAN network lies in such a private address space, too.</description>
			<type>checkbox</type>
			<bindstofield>interfaces->wan->blockpriv</bindstofield>
			<typehint>Block private networks from entering via WAN</typehint>
		</field>
		<field>
			<name>Block bogon networks</name>
			<type>listtopic</type>
		</field>
		<field>
			<donotdisable>true</donotdisable>
			<name>Block bogon networks</name>
			<description>Block bogon networks when set, this option blocks traffic from IP addresses that are reserved (but not RFC 1918) or not yet assigned by IANA. Bogons are prefixes that should never appear in the Internet routing table, and obviously should not appear as the source address in any packets you receive.</description>
			<type>checkbox</type>
			<bindstofield>interfaces->wan->blockbogons</bindstofield>
			<typehint>Block non-Internet routed networks from entering via WAN</typehint>
		</field>
		<field>
			<name>Next</name>
			<type>submit</type>
		</field>
	</fields>
	<stepsubmitbeforesave>
		if($_POST['selectedtype'] == "Static") { } else {
			$_POST['ipaddress'] = $_POST['selectedtype'];
			$config['interfaces']['wan']['ipaddr'] = $_POST['selectedtype'];
			write_config();
		}
	</stepsubmitbeforesave>
</step>
<step>
	<id>5</id>
	<title>Configure LAN Interface</title>
	<description>On this screen we will configure the Local Area Network information.</description>
	<fields>
		<field>
			<name>LAN IP Address</name>
			<type>input</type>
			<bindstofield>interfaces->lan->ipaddr</bindstofield>
			<description>Type dhcp if this interface uses dhcp to obtain its ip address.</description>
		</field>
				<field>
			<name>Subnet Mask</name>
			<type>subnet_select</type>
			<bindstofield>interfaces->lan->subnet</bindstofield>
		</field>
		<field>
			<name>Next</name>
			<type>submit</type>
		</field>
	</fields>
	<stepsubmitphpaction>
		$ft = split("\.", $_POST['lanipaddress']);
		$ft_ip = $ft[0] . "." . $ft[1] . "." . $ft[2] . ".";
		$config['dhcpd']['lan']['range']['from'] = $ft_ip . "10";
		$highestip = gen_subnet_max($_POST['lanipaddress'], $config['interfaces']['lan']['subnet']);
		$hi = split("\.", $highestip);
		$highestip = $hi[3]-10;
		$config['dhcpd']['lan']['range']['to'] = $ft_ip . $highestip;
	</stepsubmitphpaction>
</step>
<step>
	<id>6</id>
	<title>Set Admin webConfigurator Password</title>
	<description>On this screen we will set the Admin password which is used to access the webConfigurator and also SSH services if you wish to enable.</description>
	<fields>
		<field>
			<name>Admin Password</name>
			<type>password</type>
		</field>
		<field>
			<name>Admin Password AGAIN</name>
			<type>password</type>
		</field>
		<field>
			<name>Next</name>
			<type>submit</type>
		</field>
	</fields>
	<stepsubmitphpaction>
	if($_POST['adminpassword'] != "") {
		if($_POST['adminpassword'] == $_POST['adminpasswordagain']) {
			$admin_user =& getUserEntryByUID(0);
			local_user_set_password($admin_user, $_POST['adminpassword']);
			local_user_set($admin_user);
			write_config();
		} else {
			print_info_box_np("Passwords do not match!  Please press back in your browser window and correct.");
			die;
		}
	}
	</stepsubmitphpaction>
</step>
<step>
	<id>7</id>
	<stepbeforeformdisplay>
	<![CDATA[
		if(file_exists("/conf/registered_with_pfsense_org")) 
			header("Location:wizard.php?xml=traffic_shaper_wizard.xml&stepid=8");
	]]>	
	</stepbeforeformdisplay>			
	<title>Register installation</title>
	<disableheader>true</disableheader>
	<description>
		Would you like to register this pfSense installation with pfSense.org?
		&lt;p/&gt;
		No private data will be sent, only the installations hardware profile (dmesg -a).
		&lt;p/&gt;
		This data will help us understand which hardware is in use and allow us to continually improve the project.
	</description>
	<fields>
		<field>
			<name>Register</name>
			<type>checkbox</type>
			<value>on</value>
		</field>
		<field>
			<name>E-Mail</name>
			<description>Optional</description>
			<type>input</type>
			<value>on</value>
		</field>
		<field>
			<name>Continue</name>
			<type>submit</type>
		</field>
	</fields>
	<stepsubmitphpaction>
	<![CDATA[
		if($_POST['register']) {
			$dmesg_data = urlencode(`/sbin/dmesg -a`);
			$email = urlencode($_POST['e-mail']);

			$ch = curl_init();

			curl_setopt($ch, CURLOPT_URL, "http://reg.pfsense.com/reg.php");  
			curl_setopt($ch, CURLOPT_POST, "2");
			curl_setopt($ch, CURLOPT_POSTFIELDS, "dmesg=" . $dmesg_data . "&email=" . $email);

			$result = curl_exec($ch);

			curl_close($ch);

			conf_mount_rw();
			touch("/conf/registered_with_pfsense_org");
			conf_mount_ro();
		}
	]]>
	</stepsubmitphpaction>
</step>
<step>
	<id>8</id>
	<title>Reload configuration</title>
	<disableheader>true</disableheader>
	<description>Click 'Reload' to reload pfSense with new changes.  If you changed the password, pfSense will ask you to log in again.</description>
	<fields>
		<field>
			<name>Reload</name>
			<type>submit</type>
		</field>
	</fields>
</step>
<step>
	<id>9</id>
	<title>Reload in progress</title>
	<description>A reload is now in progress.  Please wait. &lt;p&gt; The system will automatically try to access $myurl in 120 seconds. &lt;p&gt; You can click on the icon above to access the site more quickly.
	&lt;meta http-equiv="refresh" content="60; url=$myurl" &gt;</description>
	<stepafterformdisplay>
		reload_all();
	</stepafterformdisplay>
</step>
</pfsensewizard>
OpenPOWER on IntegriCloud