Location: PHPKode > projects > OpenBlog mini > OpenBlog mini 1.0/README.txt
OpenBlog mini
Version 1.0

Release Date: 2012-02-06

Written By: 
Scott Carmichael, www.scottcarmichael.info, hide@address.com

For support, visit:
http://openblogmini.sourceforge.net

CODE LENGTH: < 250 lines of code


#######################################################
TABLE OF CONTENTS:
#######################################################
01: Project Overview
02: Features
03: Requirements
04: Installation
05: Editing Files & Code
06: For Programmers
07: Open Source Rights & Rules
08: Notes


PROJECT OVERVIEW:
=============================================  
OpenBlog mini (OBm) was designed as an experiment to see whether a full-featured, 
functioning Blog system could be created using less than 250 lines of code in PHP. 
It is meant for use by people who want something extremely fast loading and simple 
to setup/maintain. 


FEATURES:
=============================================  
Here are just some of the features of the OpenBlog mini:

- Web-based admin log-in/moderation system
- Over 13 easy to update style settings
- Built-in security against MySQL injection/mistakes
- Built-in Blog Search system
- Support for Post Tags
- Support for Post Permalinks
- Simple MySQL setup (uses 1 table, no-click install)
- Built with less than 250 lines of code
- Code is full of comments and well structured, organized
- HTML editing is simple and intuitive
- Easy to add additional content to (such as DISQUS comment code)
- Geared towards people who just want a simple, fast, lightweight blog
- 100% Open Source - do with it as you like! Modify and make your own version!


REQUIREMENTS:
=============================================
As long as you have a web server running PHP* and MySQL**, you can use OBm by simply 
copying the files over to your server and changing permissions on one directory. 
Free web hosts (like 110mb.com) may offer PHP support, but they do not offer the 
control needed to use this Blog properly. OBm was tested on a GoDaddy shared server 
running Windows. It may work differently on Linux hosting - I haven't had the 
opportunity to test it in that environment. PHP 5 should work just fine (though PHP 
4 may still run it).

(* - If you have 'magic_quotes' activated or other equally feature changing options 
this Blog may encounter major issues or not work at all)
(** - You need to have all the details about the DB server/login information - Host 
Name, Username, Password, Database Name)


INSTALLATION:
=============================================
1) Unzip the file from SourceForge containing the OpenBlog mini system.

2) Using Windows Explorer or a similarly capable FTP program, navigate to the location 
where you want the Blog to operate. (It does NOT have to be at the _root level and is 
recommended to be placed in a blank folder since it contains files like index.php)

3) Copy the contents of unzipped folder to the target server folder.

4) Configure the elements in sections 3 & 5 (starting on line 13) of the config.php 
file to customize the visual design of the blog. For now, let's say you 
haven't modified anything and leave the username and password as-is. (Modify content 
between "s on each line). Update section 1 (line 04) with your MySQL DB data.

5) If you placed the OBm contents in a folder called 'blog/' on your website, navigate to:
http://www.yoursite.com/blog/admin.php (link at the bottom of each page)

6) In your browser, navigate to http://www.yoursite.com/blog/install.php and if
you see a confirmation of no-errors message, the DB has been setup. If changes need
to be made, update config.php's section 1 and try again. Delete install.php after the
database has been successfully setup to avoid accidental modification.

7) To log-in initially, use the following credentials:
Username: admin
Password: test

8) At this point, you have full access to the Blog.


EDITING FILES & CODE:
=============================================
Since OpenBlog mini is 100% Open Source, you can modify anything and everything included 
in the download. However, if you just want to focus on doing low-level HTML styling and 
changing the graphics within the themes, you should only modify files in the following 
location: config.php (sections 3 & 6)

Also, if you ever want to add DISQUS comments, look on index.php and past the embed code 
in the Disqus area (line 77).


FOR PROGRAMMERS:
=============================================
As I said, OpenBlog mini was designed 100% by me from scratch. This was done in a
single day and besides making code comments as I've gone along, there are no support 
materials besides that to help someone navigate what I've made. For the sake of simplicity 
though, you only have to modify a config.php file and have the desired database log-in 
details that will be used to get it setup properly.

For security reasons, I would highly recommend renaming all instances of this variable:
$_SESSION['logged_in'] (to, say, "$_SESSION['adminuser_verify']")

You can find this variable on: 
- view.php (Line 04)
- write.php (Line 04)
- admin.php (Line 12, 20)
- delete.php (Line 04)
- index.php (Line 77)

Also, in config.php, after installing the database, if you want your table field 
names to be unique, modify the data in section 4.


OPEN SOURCE RIGHTS & RULES:
=============================================
Open Source means just that - Open Source. Anyone can modify this thing to do whatever 
they wish. The tricky part comes into play when the topics of copyrights, ownership, etc. 
arises. While I have no problem letting people use this version however they wish, I must 
say that for this initial version and the way things are coded, displayed, documented, 
etc., the "intellectual copyright" is mine (as in, "I'm saying I'm the [original 
programmer / creator] of this project"). I don't expect to get paid for this and this 
Blog is definitely not to be used to generate revenue (such as using this as a framework 
for something you are selling "as your own" to a client)...but when it comes to the 
original, "intellectual" copyright, OpenBlog mini is something only I can claim as being 
made by me. All other normal Open Source rules, rights and details apply.


NOTES:
=============================================
I'm not sure if I'm going to release another version of OpenBlog mini simply because I 
don't see myself having a lot of time...and also I think it works extremely well for what 
it's made out of (less than 250 lines of code!). I can see it being an extremely helpful 
site for any person who doesn't want to spend lots of time coding/setting up a blog and 
needs something very fast/lightweight.
Return current item: OpenBlog mini