forked from elioqoshi/phplist-manual
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ch028_installation.xhtml
182 lines (182 loc) · 11.5 KB
/
ch028_installation.xhtml
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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><title/></head><body><h1>Installing phpList manually
<br/></h1>
<p>This chapter explains how to manually install phpList. You may wish to install it using an automated tool if one is available to you. See the auto-installation chapter for more information on this.
<br/></p>
<h2>Overview of phpList installation
<br/></h2>
<p>phpList lives in its own folder called "lists." Manual installation follows these steps:
</p>
<ul>
<li>Download phpList</li>
<li>Unzip phpList</li>
<li>Upload to your server using FTP</li>
<li>Local Windows installation</li>
<li>Create a database</li>
<li>Add the database details to the config.php file</li>
<li>Configure using web interface.</li>
</ul>
<h2>Download phpList</h2>
<p>First check that your server meets the <a target="_blank" title="phpList technical System Requirements" href="https://resources.phplist.com/system/start">System Requirements<a/>. Then download the latest version of phpList from <a href="http://www.phplist.com/download">http://www.phplist.com/download</a> by clicking either <strong>Download ZIP</strong> or <strong>Download TGZ</strong>.
<br/></p>
<p><img alt="download phpList" src="static/phpList_download_1.png" height="246" width="342"/> 
</p>
<p>The link will take you to SourceForge, where your download will begin after a few seconds. Depending on which browser you use, you may be asked to click <strong>Save</strong> before the download starts.
</p>
<h2>Unzip phpList
<br/></h2>
<p> Once you have downloaded phpList to your computer, unpack it to a temporary folder. You can usually do this by right clicking and choosing <strong>Extract Here</strong> (Linux, as in screenshot), double clicking the folder (mac) or right click "extract all" (Windows).
</p>
<p><img alt="extracting phpList install using geddit on Linux" src="static/phpList_extract_here.png" height="503" width="560"/></p>
<h2>Upload to your server using FTP
</h2>
<p>Start your favourite FTP program, in this case we are using FileZilla.
</p>
<p>Browse though to your temporary folder in the FTP program, then open the public_html folder to find the lists folder.
</p>
<p><img alt="public_html folder phpList" src="static/navigate_to_extracted_phplist.png" height="405" width="413"/> 
</p>
<p>Upload this <strong>/lists</strong> folder into your public_html file on your server. This folder may have lots of files in it already. In the image below you can see the public_html folder on the server contains folders for a WordPress site.
<br/></p>
<p><img alt="using filezilla to install phpList" src="static/phpList_upload_lists_1.png" height="343" width="600"/><br/></p>
<h2>Grab a Coffee!
</h2>
<p>This upload may take some time, you may even have to split it over a number of partial uploads depending on your connection speed, time outs and upload limits.
<br/></p>
<p><img alt="uploading phpList via ftp" src="static/phpList_uploaded_lists.png" height="265" width="395"/> 
</p>
<p>
</p>
<h2>Local Windows installation
<br/></h2>
<p> If you do not own a server or you want to develop locally, you can also install phpList on your Windows machine. First, you need to download the <a href="https://www.apachefriends.org/index.html" target="_blank">XAMPP</a> package and install it in your PC. After installing, copy the /lists folder as stated in the previous section and paste it in the htdocs folder of XAMPP.
</p>
<p><img alt="moving lists folder to xampp folder" src="static/xampp_file_move.png" height="500" width="750"/> 
</p>
<p> Next up, you must run the XAMPP Control Panel and start the Apache and MySQL server. Now we are ready to create a database for phpList on which to save the data.
</p>
<p><img alt="starting servers" src="static/xampp_control_panel.png" height="480" width="720"/> 
</p>
<h2>Create a database using your control panel
<br/></h2>
<p> Once you have uploaded the<strong> /lists</strong> directory, go to your hosting control panel or to the localhost from your browser and create a database. If you need help, your web hosting company can help you with this.
</p>
<p>Whatever the process, you will always end up with three things:
</p>
<ul><li>A database name, for example cl52-phplist</li>
<li>A database username, for example phplist</li>
<li>A password for your database, for example T!LcDaM/4</li>
</ul><h3>An example of creating a database
<br/></h3>
<p>
</p>
<p><em>These screenshots provide an example. This may or may not be similar to the way you can create a new database on your server. That depends entirely on which software your hosting company uses.</em>
<br/></p>
<p>First click <strong>MySQL Databases</strong>.
<br/></p>
<p><img alt="cpanel MySQL Databases phpList install" src="static/database_backup_phpList_1.png" height="317" width="423"/> 
</p>
<p> Then type in the new database name (we used the name phpList) and enter or generate a strong password. <em>Make sure you keep a copy of these details</em>!
</p>
<p>
</p>
<p><img alt="chosing database username and password during phpList install" src="static/database_1_1.png" height="164" width="650"/></p>
<p>This system creates a user automatically, where the username is the same as the database name (a common preference). In other software you may need to add a new user separately and you may also need to allocate this user to your database.
</p>
<p>Your database is now ready. Copy down the details because you will need them in a moment.
<br/></p>
<p><img alt="creating a new database during phpList install" src="static/new_database_1.png" height="261" width="562"/> 
</p>
<h2 id="edit-the-phplist-config-php-file">Edit the phpList config.php file
</h2>
<p>
<br/>Next, you need to put the details of your new database into your configuration file.
<br/></p>
<p>Browse your temp folder on your computer and go to<strong> lists </strong>> <strong>config </strong>><strong> config.php</strong>. Load and edit this file in a <em>text editor</em>, such as Notepad (windows) TextEdit (mac) or Geany/Kate/Geddit/etc (linux).
<br/></p>
<p><img alt="open phpList config.php in a text editor" src="static/edit_config.png" height="197" width="432"/><br/></p>
<p> <em>Never </em> use a word processor program (like Microsoft Word), it will only generate formatting and disruption.
<br/><br/>Your freshly downloaded config.php should look something like this:
</p>
<p><img alt="edit phpList config.php in a text editor" src="static/config_phpList_1.png" height="792" width="600"/><br/></p>
<p>There are four places where you need to replace the word in "quotes" at the end of a line of code with something specific to your server:
<br/></p>
<h3># what is your Mysql database server hostname
<br/>$database_host = "localhost";
</h3>
<p>If you do not know what to enter here, you will either need to use trial and error, or ask your hosting provider what to put here. <em>If you want to keep things simple, ask your hosting provider. </em>
</p>
<h4><strong>Trial and error:</strong>
</h4>
<p>You may be lucky in that your server allows "<strong>localhost</strong>" for your $database_host entry,  in which case you don't need to make a change (this was true in our example below). The second option to try is "127.0.0.1".
</p>
<p>If these fail you will receive an error towards the end of installation. If both of these fail then this entry must be something specific to your server. GoDaddy and 1&1 servers are pretty specific, for example.
</p>
<h3># what is the name of the database we are using
<br/>$database_name = "phplistdb";
</h3>
<p>Replace the<strong> phplistdb</strong> with the name of your database that you set up earlier. In our example below this is <strong>cl52-phplist</strong>.
<br/></p>
<h3>
</h3>
<h3># what user has access to this database
<br/>$database_user = "phplist";
</h3>
<p>Replace the<strong> phplist</strong> with the name of your databse user you set up earlier (this may be the same name as your database). In our example below this is also <strong>cl52-phplist</strong>.
</p>
<h3># and what is the password to login to control the database
<br/>$database_password = 'phplist';
</h3>
<p>Replace the <strong>phplist</strong> with the password you created. The password in the example below is obscured.<img alt="how to edit phpList config.php" src="static/phpList_initial_config.png" height="276" width="663"/></p>
<h3>Test mode in phpList: ("TEST",0)
</h3>
<p>One other thing you will need to do, either now or at some point in the future, is to change the value of <strong>TEST</strong> in this file. Until you do this, your install is essentially in "sandbox" mode, and will not fully function.
</p>
<p>By default test is defined ("TEST",1). Change this to define ("TEST",0) to be able to send messages out.
</p>
<p>This is done automatically in the auto installers.
</p>
<h3>Config_extended.php
</h3>
<p>You may need to add some extra lines to your config.php. These extra lines are ready made for you in config_extended.php, which is in the same directory as config.php. Simply copy the lines you need and paste them below the others in config.php
<br/></p>
<h2>Save and upload
</h2>
<p> Once you have edited the config.php file you need to save it and upload this new version to your server. This can be done in the same way as your initial upload: open your ftp client, find the <strong>lists/config/config.php</strong> file on your pc and then upload it to <strong>lists/config/config.php</strong> on your server.
</p>
<h2>Go to your installation
</h2>
<p>Open your web browser and go to your installation. This is located at <strong>http://mywebsite.co.uk/lists/admin.</strong>
</p>
<p>If you get an error saying that the database has not connected, then check your config.php file again: a tiny error such as a space before/after your database name/password will stop this from working.
</p>
<p>When you see the grey and black interface with the phpList logo at the top, you are in the right place.
</p>
<p><img alt="phpList initialise database after install" src="static/go_to_install.png" height="269" width="600"/><br/></p>
<h2>The final steps<del>
<br/></del>
</h2>
<p> Click <strong>Initialise Database</strong> and fill out the form.
</p>
<p><img alt="phpList initialise database name and password" src="static/Initialise_database_phpList.png" height="564" width="561"/><br/></p>
<p>Click <strong>Continue</strong>
</p>
<p><img src="static/sign_up_to_list.png" alt="phpList install complete sign up to announcements list" height="290" width="600"/><br/></p>
<ul><li>If you would like to email phpList to let us know you are using the software, click <strong>Tell us about it</strong>.
<br/></li>
<li>We recommend that you sign up to receive email announcements about new versions of phpList. You can enter your email and click<em> </em><strong>Subscribe. </strong>If you do not want to sign up, for example because you are already on the list, then click <strong>Do not subscribe</strong>.</li>
</ul><p>Finally click to continue with <strong>phpList seutp</strong>.
</p>
<p>
<br/><img src="static/install_complete.png" alt="phpList install complete continue with setup" height="357" width="383"/><br/></p>
<ul/><h2>You're done!
</h2>
<p>You have now finished installation, and the next step is configuration.
</p>
<p><img alt="phpList installation complete" src="static/configuration.png" height="374" width="421"/><br/></p>
<h2> Feedback
</h2>
<p>Discuss this chapter <a href="https://discuss.phplist.org/t/installing-phplist-manually-manual-chapter-feedback-and-discussion/212">here</a>.
<br/></p></body></html>