1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" |
2 |
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
3 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
4 |
<head> |
5 |
<title>Reblog Installation</title> |
6 |
<link rel="stylesheet" href="softwarestyle.css" type="text/css" /> |
7 |
</head> |
8 |
<body> |
9 |
<h1>Reblog Installation</h1> |
10 |
<p>$Revision: 1.15 $</p> |
11 |
<div id="contents"> |
12 |
<ol> |
13 |
<li> |
14 |
<p> |
15 |
Copy the file <code>config.php.default</code> to <code>config.php</code>, and add your local configuration information (note: most of these settings are further documented in the <code>config.php.default</code> file). |
16 |
</p> |
17 |
<p> |
18 |
<strong>Database settings:</strong> |
19 |
</p> |
20 |
<dl> |
21 |
<dt><code>REBLOG_DSN</code></dt> |
22 |
<dd>Database connection information, like <code>mysql://username:password@hostname/database</code>. |
23 |
<br /> |
24 |
<strong>During installation</strong>, be sure that the database user you set up has <code>create</code>, <code>drop</code> and <code>alter</code> privileges on the Reblog database so that tables may be created. |
25 |
<strong>After</strong> installation, normal use requires <code>select</code>, <code>insert</code>, <code>update</code> and <code>delete</code> privileges.</dd> |
26 |
<dt><code>REBLOG_*_TABLE</code></dt> |
27 |
<dd>If you want to change what your database tables are called, there are four.</dd> |
28 |
</dl> |
29 |
<p> |
30 |
<strong>Other settings:</strong> |
31 |
</p> |
32 |
<dl> |
33 |
<dt><code>REBLOG_TIMEZONE</code></dt> |
34 |
<dd>Your local timezone, if different from the server's. |
35 |
Choose a value from the collection at <a href="http://www.php.net/manual/en/timezones.php">http://www.php.net/manual/en/timezones.php</a>.</dd> |
36 |
<dt><code>REBLOG_USE_KEYBOARD</code></dt> |
37 |
<dd>Yes/no: Use the keyboard-sensitive navigation and functionality?</dd> |
38 |
<dt><code>REBLOG_AUTH_TYPE</code></dt> |
39 |
<dd>How do we authenticate the user, and manage user accounts |
40 |
(values = <code>RF</code> or <code>MT</code> or <code>WP</code>). |
41 |
See <a href="ACCOUNTS.html">ACCOUNTS.html</a> for more info, but if you just want one |
42 |
user you can leave the default <code>RF</code> and forget about it.</dd> |
43 |
<dt><code>REBLOG_HTTPAUTH_NAME</code>, <code>REBLOG_HTTPAUTH_PASS</code></dt> |
44 |
<dd>User name and password for HTTP authentication. |
45 |
If set, you will be prompted forthis information when you attempt to use the parts of Reblog that change the database.</dd> |
46 |
<dt><code>REBLOG_AUTHOR_NAME</code></dt> |
47 |
<dd>Author name for your outgoing feed.</dd> |
48 |
<dt><code>REBLOG_FEED_TITLE</code></dt> |
49 |
<dd>Title of your outgoing feed.</dd> |
50 |
<dt><code>REBLOG_FEED_DESCRIPTION</code></dt> |
51 |
<dd>Description of your outgoing feed.</dd> |
52 |
<dt><code>REBLOG_LINK_NEW_WINDOWS</code></dt> |
53 |
<dd>Yes/no: should links open in new windows?</dd> |
54 |
<dt><code>REBLOG_HOWMANY</code></dt> |
55 |
<dd>Number of items to show in a listing, by default.</dd> |
56 |
<dt><code>REBLOG_KEEP_DAYS</code></dt> |
57 |
<dd>Number of days to keep items. Archived items older than this are pruned.</dd> |
58 |
<dt><code>REBLOG_KEEP_UNREAD</code></dt> |
59 |
<dd>Yes/no: Also prune unread items after <code>REBLOG_KEEP_DAYS</code> days.</dd> |
60 |
<dt><code>REBLOG_GUID_PREFIX</code></dt> |
61 |
<dd>Globally unique identifying prefix for items in your outgoing feed. If you don't know what this is, odds are you don't need to change it.</dd> |
62 |
<dt><code>REBLOG_ADMIN_FEEDS</code></dt> |
63 |
<dd>Yes/no: Is the user allowed to modify the feeds list?</dd> |
64 |
<dt><code>REBLOG_UPDATE_FEEDS</code></dt> |
65 |
<dd>Yes/no: Is the user allowed to update the feeds?</dd> |
66 |
<dt><code>REBLOG_POST_NEW</code></dt> |
67 |
<dd>Yes/no: Is the user allowed to post new items?</dd> |
68 |
</dl> |
69 |
</li> |
70 |
<li> |
71 |
<p> |
72 |
Upload the entire tree to wherever on your server you want Reblog to live. |
73 |
</p> |
74 |
</li> |
75 |
<li> |
76 |
<p> |
77 |
Create a directory called <code>cache</code> inside your Reblog directory, and make it world-writeable (<code>chmod a+rwX cache</code>). |
78 |
</p> |
79 |
</li> |
80 |
<li> |
81 |
<p> |
82 |
Load the page <code>http://{your server}/{wherever you put Reblog}/install.php</code>. The installer will first check that it can connect to your DB, and then attempt to create your database tables. |
83 |
</p> |
84 |
</li> |
85 |
<li> |
86 |
<p> |
87 |
Play around and figure out how it works. It's pretty straightforward. Or see the <a href="guide/index.html">Users' Guide</a>. |
88 |
</p> |
89 |
</li> |
90 |
<li> |
91 |
<p> |
92 |
Optionally setup a <a href="http://en.wikipedia.org/wiki/Crontab">cron job</a> to perform feed updates on your behalf. Add a call to <code>GET</code>, <code>wget</code> or <code>curl</code> to your crontab, and have it request <code>http://{your server}/{wherever you put Reblog}/update-quiet.php</code>. |
93 |
</p> |
94 |
<p> |
95 |
Example: |
96 |
</p> |
97 |
<p> |
98 |
<code> |
99 |
# Update all feeds once per hour |
100 |
<br /> |
101 |
0 * * * * /usr/bin/curl -I "http://example.com/reblog/update-quiet.php" |
102 |
</code> |
103 |
</p> |
104 |
</li> |
105 |
</ol> |
106 |
</div> |
107 |
</body> |
108 |
</html> |