summaryrefslogtreecommitdiff
path: root/InstallationNotes.md
diff options
context:
space:
mode:
authorAndrew Dolgov <[email protected]>2015-07-26 02:03:34 +0300
committerAndrew Dolgov <[email protected]>2015-07-26 02:03:34 +0300
commit80754cc5aa414d128051d6fdb0fc1357449a01ce (patch)
tree7a74eb8c7a64bdfa79ad4f04bda8948d7464cc87 /InstallationNotes.md
parentbb4a2d5e85db57cef69ab47eb77bc0c65c60530b (diff)
fox deleted page: MobileVersion
Diffstat (limited to 'InstallationNotes.md')
-rw-r--r--InstallationNotes.md43
1 files changed, 21 insertions, 22 deletions
diff --git a/InstallationNotes.md b/InstallationNotes.md
index 415ba9c..39180b8 100644
--- a/InstallationNotes.md
+++ b/InstallationNotes.md
@@ -6,21 +6,21 @@ Installing Tiny Tiny RSS for the first time
Before you begin, you’ll need to verify the following:
-1\. You need access to a hosting/VDS running a http server and a database
-(mysql or postgresql). Your database should properly support unicode.\
+1. You need access to a hosting/VDS running a http server and a database
+(mysql or postgresql). Your database should properly support unicode.
2. You will need to acquire database credentials, i.e. login, password,
and a database name. If you don’t have a database already created, you
need to do so before installing. Tiny Tiny RSS can coexist with other
applications in a shared database, creating a dedicated one is not
-necessary.\
+necessary.
3. Your http server should be running PHP version 5.3 or later. Having
-an accelerator like php-apc is highly recommended.\
+an accelerator like php-apc is highly recommended.
4. The manual assumes you have basic knowledge of Git SCM.
After you have gone through the above list, you can proceed to the
installation.
-1\. Clone tt-rss repository using Git
+1. Clone tt-rss repository using Git
<code>git clone https://github.com/gothfox/Tiny-Tiny-RSS.git tt-rss</code>
@@ -31,48 +31,47 @@ you.
If you don’t want to deal with repositories, Github has a “Download ZIP”
button (not recommended).
-2\. Verify that you can open http://your.site.com/tt-rss/install/
+2. Verify that you can open http://your.site.com/tt-rss/install/
-3\. Proceed with the installation using the easy installer. It will ask
+3. Proceed with the installation using the easy installer. It will ask
your database credentials and a full URL on which tt-rss will be
accessed, for example <code>http://your.site.com/tt-rss/install/</code>.
It is required that the URL is an externally accessible one (if any),
don’t use <code>localhost</code> there, it will break PUSH support. If
you are deploying tt-rss on LAN, you can disregard this requirement.
-4\. The easy installer will generate <code>config.php</code> for you,
+4. The easy installer will generate <code>config.php</code> for you,
after you have entered your database credentials and initialized tt-rss
database. You will need to either copy text from the installer and paste
it into <code>config.php</code> on the server, or, if possible, the
installer will be able to do it for you automatically.
-5\. It is suggested that you read through <code>config.php</code> to see
+5. It is suggested that you read through <code>config.php</code> to see
if you need to enable additional functionality or change default
configuration values.
-5\. After finishing with the installer, open your Tiny Tiny RSS
+5. After finishing with the installer, open your Tiny Tiny RSS
installation at <code>http://your.site.com/tt-rss/</code> and login with
default credentials (username: <code>admin</code>, password:
<code>password</code>).
-6\. Go to preferences and change your password!
+6. Go to preferences and change your password!
-7\. You will also need to decide on the method tt-rss uses to update
-feeds. This is a separate topic, outlined in [[UpdatingFeeds]].
+7. You will also need to decide on the method tt-rss uses to update
+feeds. This is a separate topic, outlined in [UpdatingFeeds](UpdatingFeeds).
-7\. If all went well, you may proceed to use tt-rss normally. Create a
+7. If all went well, you may proceed to use tt-rss normally. Create a
separate non-admin user, login under it, and start importing your feeds,
subscribing, and configure it to your taste.
-8\. That’s all!
+8. That’s all!
-Don’t forget to read [[UpdatingFeeds]] otherwise your feeds won’t update
+Don’t forget to read [UpdatingFeeds](UpdatingFeeds) otherwise your feeds won’t update
automatically.
### Take a look at available plugins
-There are many plugins written for tt-rss. You can see the list here:
-[[Plugins]].
+There are many plugins written for tt-rss. You can see the list here: [Plugins](Plugins).
Upgrading Tiny Tiny RSS
-----------------------
@@ -116,11 +115,11 @@ with your normal account.
3. Post-upgrade tasks
---------------------
-1\. You might need to clear your browser cache if you experience CSS or
-script-related issues, older scripts might have stuck in it.\
+1. You might need to clear your browser cache if you experience CSS or
+script-related issues, older scripts might have stuck in it.
2. Do not copy cache directories from your old tt-rss version, it is
unnecessary and potentially creates problems if you don’t preserve file
-modification times.\
-2. If you are using an accelerator like php-apc you might need to
+modification times.
+3. If you are using an accelerator like php-apc you might need to
restart apache if older cached versions of PHP files got stuck in cache
(this happens rarely, but is a possibility).