source: trunk/smf/readme.html @ 1184

Revision 852, 8.4 KB checked in by cdleonard@…, 4 years ago (diff)

svn:eol-style native in trunk. Also svn:executable on all scripts

  • Property svn:eol-style set to native
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html>
3        <head>
4                <title>SMF 1.1 Installation Guide</title>
5                <style type="text/css">
6                        body
7                        {
8                                background-color: #E5E5E8;
9                                margin: 0px;
10                                padding: 0px;
11                        }
12                        body, td
13                        {
14                                color: #000000;
15                                font-size: small;
16                                font-family: verdana, sans-serif;
17                        }
18                        div#header
19                        {
20                                background-image: url(Themes/default/images/catbg.jpg);
21                                background-repeat: repeat-x;
22                                background-color: #88A6C0;
23                                padding: 22px 4% 12px 4%;
24                                color: white;
25                                font-family: Georgia, serif;
26                                font-size: xx-large;
27                                border-bottom: 1px solid black;
28                                height: 40px;
29                        }
30                        div#content
31                        {
32                                padding: 20px 30px;
33                        }
34
35                        div.panel
36                        {
37                                border: 1px solid gray;
38                                background-color: #F6F6F6;
39                                margin: 1ex 0 3ex 0;
40                                padding: 1.2ex;
41                        }
42                        div.panel h2
43                        {
44                                margin: 0;
45                                margin-bottom: 2ex;
46                                padding-bottom: 3px;
47                                border-bottom: 1px dashed black;
48                                font-size: 14pt;
49                                font-weight: normal;
50                        }
51
52                        dl
53                        {
54                                margin-left: 3ex;
55                        }
56                        dt
57                        {
58                                font-style: italic;
59                        }
60                        dd
61                        {
62                                margin-bottom: 1ex;
63                        }
64
65                        div.code
66                        {
67                                margin: 1ex 3ex 2ex 3ex;
68                                padding: 3px;
69                                background-color: #FAFAFA;
70                                font-family: monospace;
71                                overflow: auto;
72                        }
73                        div.code span.comment
74                        {
75                                font-style: italic;
76                                color: #000066;
77                        }
78                </style>
79        </head>
80        <body>
81                <div id="header">
82                        <div title="Shinra">SMF 1.1 Installation Guide</div>
83                </div>
84                <div id="content">
85                        <div class="panel">
86                                <h2 id="contents">Installing your forum</h2>
87
88                                Thank you for deciding to use, or at least try, <a href="http://www.simplemachines.org/smf/">SMF</a>.  Before you get started, please remember that there is <a href="http://www.simplemachines.org/community/index.php">a place for help at www.simplemachines.org</a> if you run into any problems at all.<br />
89                                <br />
90                                If you are looking to upgrade an installation of SMF, or convert from YaBB SE, you may have downloaded the wrong package.  Please check <a href="http://www.simplemachines.org/download.php">the downloads page</a> for more information.<br />
91                                <br />
92                                You can find the following information in this file:<br />
93
94                                <ul type="none" style="list-style-type: none;">
95                                        <li>&raquo; <a href="#requirements">Minimum installation requirements.</a></li>
96                                        <li>&raquo; <a href="#uploading">Uploading SMF onto your webserver.</a></li>
97                                        <li>&raquo; <a href="#finishing">Finishing the installation and cleaning up.</a></li>
98                                </ul>
99                        </div>
100
101                        <div class="panel">
102                                <h2 id="requirements">What's required to install SMF?</h2>
103
104                                Your server must meet a few requirements to be able to run SMF.  If you unsure as to whether your webserver meets these, please try the installer - it should detect any problems.<br />
105
106                                <ul>
107                                        <li>Any webserver that properly supports PHP, such as <a href="http://httpd.apache.org/" target="_blank">Apache</a> or <a href="http://www.microsoft.com/iis" target="_blank">Internet Information Services (IIS)</a>.</li>
108                                        <li>
109                                                <a href="http://www.php.net" target="_blank">PHP</a> 4.1.0 or higher.  The following directives are required to be set correctly in php.ini:
110                                                <ul>
111                                                        <li>the engine directive must be On.</li>
112                                                        <li>the <a href="http://www.php.net/sybase#ini.magic-quotes-sybase" target="_blank">magic_quotes_sybase</a> directive must be set to Off.</li>
113                                                        <li>the <a href="http://www.php.net/session#ini.session.save-path" target="_blank">session.save_path</a> directive must be set to a valid directory.</li>
114                                                        <li>the <a href="http://www.php.net/configuration.directives#ini.file-uploads" target="_blank">file_uploads</a> directive must be On.</li>
115                                                        <li>the <a href="http://www.php.net/configuration.directives#ini.upload-tmp-dir" target="_blank">upload_tmp_dir</a> must be set to a valid directory.</li>
116                                                </ul>
117                                        </li>
118                                        <li><a href="http://www.mysql.com/" target="_blank">MySQL</a> 3.23.28 or higher.</li>
119                                        <li>at least 512 kilobytes of storage space in the database, although more is highly recommended.</li>
120                                        <li>about two and a half megabytes of storage space on the web server, although more is recommended.</li>
121                                </ul>
122
123                                Recommendations for best performance:<br />
124
125                                <ul>
126                                        <li><a href="http://www.linux.org/" target="_blank">Linux</a> or another Unix based operating system.</li>
127                                        <li>the <a href="http://aspell.sf.net/" target="_blank">GNU Aspell</a> and <a href="http://ftp.gnu.org/gnu/aspell/dict/" target="_blank">its dictionaries</a> for spell checking support.</li>
128                                        <li><a href="http://httpd.apache.org/" target="_blank">Apache</a> with <a href="http://httpd.apache.org/docs-2.0/mod/core.html#acceptpathinfo" target="_blank">AcceptPathInfo</a> set to On (Apache 2 and later only) for queryless URL support.</li>
129                                        <li>
130                                                <a href="http://www.php.net" target="_blank">PHP</a> 4.3.0 or higher, with the following set in php.ini:
131                                                <ul>
132                                                        <li>the <a href="http://www.php.net/ref.info#ini.max-input-time" target="_blank">max_input_time</a> directive is set to a value of at least 30.</li>
133                                                        <li>the <a href="http://www.php.net/configuration.directives#ini.post-max-size" target="_blank">post_max_size</a> and <a href="http://www.php.net/configuration.directives#ini.upload-max-filesize" target="_blank">upload_max_filesize</a> directives are set to the size of the largest attachments you wish to be able to upload.</li>
134                                                        <li>the <a href="http://www.php.net/session#ini.session.use-trans-sid" target="_blank">session.use_trans_sid</a> directive set to Off.</li>
135                                                        <li>the <a href="http://www.php.net/configuration.directives#ini.memory-limit" target="_blank">memory_limit</a> directive is set to at least 8M.</li>
136                                                        <li>the <a href="http://www.php.net/info#ini.max-execution-time" target="_blank">max_execution_time</a> directive is set to at least 15.</li>
137                                                        <li>the <a href="http://www.php.net/configuration.directives#register-globals" target="_blank">register_globals</a> directive is set to Off.</li>
138                                                </ul>
139                                        </li>
140                                        <li><a href="http://www.mysql.com/" target="_blank">MySQL</a> 4.0.15 or higher with query caching enabled.</li>
141                                        <li><a href="http://www.boutell.com/gd/" target="_blank">GD Graphics Library</a> 2.0 or higher.</li>
142                                </ul>
143
144                                If your server does not meet these requirements, SMF may not work properly.
145                        </div>
146
147                        <div class="panel">
148                                <h2 id="uploading">Uploading the files</h2>
149
150                                The first thing you need to do is upload all of the files in this package, excluding this file itself, to your server.  You can upload it to any directory accessible by URL, but if you're not sure where to put it, a directory named &quot;forum&quot; is a good choice.  You may wish to make sure that all of the folders were uploaded, such as <tt>Themes/default/languages</tt>, because some FTP clients have been known to drop files.<br />
151                                <br />
152                                If you want or need to install any languages other than English, download the corresponding versions from the download page, and upload them to the same directory you uploaded SMF to.  This should put additional files in <tt>Themes/default/languages</tt> and, in most cases, <tt>Themes/default/images</tt>.
153                                <br />
154                                After you have finished uploading the files, point your browser to http://www.yourdomain.tld/forum/install.php - where www.yourdomain.tld/forum is the URL to where you uploaded it.  You should then see an installer interface.<br />
155                                <br />
156                                The first page you see may request your FTP information.  If you see this screen, it is because the installer found some files or folders with inadequate permissions for SMF to run properly.  If you enter your FTP information here, the installer can automatically fix these permissions for you.  Please note that the path should be the same path you see in your FTP client.  For example, it might be &quot;public_html/forum&quot;.  And remember, the installer will not save your FTP password anywhere.
157                        </div>
158
159                        <div class="panel">
160                                <h2 id="finishing">Finishing everything up</h2>
161
162                                From this point, the installer should walk you through all the information you need to enter.  There isn't much more, so don't worry.<br />
163                                <br />
164                                Please remember to delete the installer after finishing the installation.  If you do not delete it, it is possible that someone could compromise the security of your forum.<br />
165                                <br />
166                                Good luck!<br />
167                                Simple Machines
168                        </div>
169                </div>
170        </body>
171</html>
Note: See TracBrowser for help on using the repository browser.