Installation Guide
Administration
General Settings
Category Management
Source Management
- Adding a new source
- Editing a source
- Deleting a source
- Associating a source with a specific category
- Defining a source as no-follow or do-follow
- Uploading a new favicon for a source
Timescales
Pruning Articles
Configure Update Automation
Installation Guide
Installation of PHP RSS Reader is straight forward and on average should take no longer than just a few minutes.
- Uploading and Installing PHP RSS Reader
- Open and extract PHP RSS Reader 1.0.zip to a location on your computer
- Upload the contents of the ‘rss’ folder to the root or subfolder of your site you’d like the script to be accessible
- Navigate using your web browser to the ‘install.php’ file, if you uploaded to your root folder, for this example this would be: www.example.com/install.php
- Follow the on-screen 3 step process to enter your mysql and username details
Administration
To access the admin panel, simple navigate to the /admin folder in your web browser, for example: www.example.com/admin
General Settings
The general settings within PHP RSS Reader allows you to edit the site title, description, root url, folder path, news item sub folder, amount of homepage articles to display, topics per page, popular posts per page, related articles per page, Google Analytics ID and reset the admin password.
To find this area, simple click the ‘settings’ link in the navigation when in the admin panel.
Category Management
- Creating a category
- Click ‘categories’ in the navigation bar
- Enter a name for the category
- Enter relevant keywords for the category (used to search the database for relevant news). The keywords need to be seperated by a comma, e.g ‘apple, iphone’
- Select a parent category if desired
- click ‘Add’
- Editing a category
- Click ‘categories’ in the navigation bar
- See ‘current categories’ section
- Click which category you wish to edit
- Deleting a category
- Click ‘categories’ in the navigation bar
- See ‘current categories’ section
- Click the category you wish to delete
- Click ‘delete in the top right hand corner
- Re-ordering categories
- Click ‘categories’ in the navigation bar
- See ‘current categories’
- Simply click ‘move up’ or ‘move down’ to reorder
Source Management
For the script to crawl a source you need to know the source’s RSS feed URL.
- Adding a new source
- Click ‘sources’ in the navigation bar
- Enter a name for the source
- Enter the source’s homepage URL
- Enter the source’s RSS feed URL
- Define whether this is a normal RSS feed or a Twitter feed
- Click ‘Add’
- Editing a source
- Click ‘sources’ in the navigation bar
- See ‘current sources’ section
- Click which source you’d like to edit
- Deleting a source
- Click ‘sources’ in the navigation bar
- See ‘current sources’ section
- Click the source you wish to delete
- Click ‘delete’ in the top right hand corner
- Associating a source with a specific category (all items from this source will always appear in the selected categories
- Click ‘sources’ in the navigation bar
- See ‘current sources’ section
- Click the source you wish to edit
- Select ‘associated categories’ (multiple selections allowed)
- Defining a source as no-follow or do-follow (for the sources links back to its site)
- Click ‘sources’ in the navigation bar
- See ‘current sources’ section
- Click the source you wish to edit
- Select ‘no-follow’ or ‘do-follow’ from the ‘link type’ dropdown
- Uploading a new favicon for a source
- Click ‘sources’ in the navigation bar
- See ‘current sources’ section
- Click the source you wish to edit
- Under ‘current favicon’ click ‘browse’ upload a new image as this source’s favicon (to save favicons to your computer, we suggest: http://www.getfavicon.org/
Timescales
Timescales are used to divide the news up into chunks, making it easier for the user to identify the latest news. On the demo you will see section headings such as ‘new in last 5 minutes’. These timescales can be configured within the admin panel.
- Adding a new timescale
- Click ‘timescales’ in the navigation bar
- Enter the name of the timescale you wish to add
- Select how many ‘minutes’, ‘hours’ or ‘days’ from the drop down
- Click ‘Add’
- Editing a timescale
- Click ‘timescales’ in the navigation bar
- See ‘timescales’ section
- Click which timescale you’d like to edit
- Deleting a timescale
- Click ‘timescales’ in the navigation bar
- See ‘timescales’ section
- Click the timescale you wish to delete
- Click ‘delete’ in the top right hand corner
Pruning Articles
As your database gets larger, you may wish to prune articles that are older than a specific date.
- Click ‘articles’ in the navigation bar
- Select ‘hours’, ‘weeks’, ‘days’ or ‘months’ from the dropdown to indicate how old an article needs to be, to be deleted.
- Click ‘delete’
Configure Update Automation
Your site can be updated manually from the /update subfolder, e.g: www.example.com/update
However, it’s possible to put this on autopilot. Within your hosting providers control panel, there should be a section named ‘crontabs’.
Within this section, you can define how often a command should be run. For example, if you’d want your site look for new articles from your sources every five minutes, you can define this within the crontab.
The common command line used for a crontab with PHP RSS Reader is:
wget -O –
If there is no ‘crontab’ section within your hosting control panel, please take a look at your hosts documentation or get in touch with your hosting support staff. Whilst crontabs are available on the overwhelming majority of hosts in this day and age, sometimes it could be the case you need to send a quick email to your hosting support staff to get them configured.