eggBlog

Docs & Guides

posted by Egg @ 12:41pm, Friday 16 November 2007.

The following documentation and guides reffer to eggblog v4. Any previous versions are no longer supported.

Introduction Video
Requirements
Installing
Upgrading
- Upgrading from eggBlog v3
- Upgrading from eggBlog v4
Language Files
Administration
Templates
- Sidebar
- Footer (Traffic Monitoring)
Change Log

Introduction Video
Below is a video to act as an introduction to eggBlog v4.

This shows how to edit an article, how to create (and then delete) an article, and finally how to change themes for your blog.

Requirements
The following are required:

Installing
The installation instructions are as follows:

Download either the .zip, .7z or .tar.gz compressed package from:
http://eggblog.net/download.php
Unpack the package to your chosen directory on your web server.
Copy /config.inc.php to /config.php and edit to complete all fields:
- $config['lang'] - the filename of the language file in /langs/
- $config['theme'] - the name of the folder in /themes/ containing the theme
- $config['email'] - your email address
- $config['title'] - the title of your website
- $config['subtitle'] - the subtitle of your website
- $config['meta_desc'] - a short description of your website for meta tags
- $config['meta_keys'] - comma seperated words for meta tags
- $config['forums'] - set to 1 to enable the forums, or 0 to disable
- $config['photos'] - set to 1 to enable the photo albums, or 0 to disable
- $config['mysql_host'] - hostname/ip of your MySQL server
- $config['mysql_user'] - username for your MySQL account
- $config['mysql_pass'] - password for your MySQL account
- $config['mysql_db']- your MySQL database name
- $config['uri'] - URL of your website with trialing slash, e.g. http://eggblog.net/demo/
Change permissions for the following to read, write and exectuable (chmod 0777):
- /config.php
- /photos/full/
- /photos/category/
- /photos/thumbnail/
- /photos/uploads/
Open your browser to http://www.your-server/eggblog4/install.php
Delete /install.php and upgrade_3to4.php

Upgrading from v4
The upgrade from eggBlog4 instructions are as follows:

Download either the .zip, .7z or .tar.gz compressed package from:
http://eggblog.net/download.php
Unpack the package and upload all files except /photos/.
Delete /install.php and upgrade_3to4.php
If upgrading from v4.0b, v4.0RC1 or v4.0RC2, you will need to make adjustments to the config.php file:
1. if using "en-uk.php" language file, change to the new lUK language file "en_gb.php"
2. change $config['mysql_table'] to $config['mysql_db']
3. enter the administration area of your installation and save the settings - this will ensure the config file is complete.

Upgrading from v3-v4
The upgrade from eggBlog3 to eggBlog4 instructions are as follows:

Download either the .zip, .7z or .tar.gz compressed package from:
http://eggblog.net/download.php
Unpack the package to your chosen directory on your web server.
If you are upgrading to the same location as your previous installation, delete all files/folders except /photos/.

If you are installing to a different location you will need to copy the /photos/ directory to your new folder.
Copy /config.inc.php to /config.php and edit to complete all fields:
- $config['lang'] - the filename of the language file in /langs/
- $config['theme'] - the name of the folder in /themes/ containing the theme
- $config['email'] - your email address
- $config['title'] - the title of your website
- $config['subtitle'] - the subtitle of your wbesite
- $config['meta_desc'] - a short description of your website for meta tags
- $config['meta_keys'] - comma seperated words for meta tags
- $config['forums'] - set to 1 to enable the forums, or 0 to disable
- $config['photos'] - set to 1 to enable the photo albums, or 0 to disable
- $config['mysql_host'] - hostname/ip of your MySQL server
- $config['mysql_user'] - username for your MySQL account
- $config['mysql_pass'] - password for your MySQL account
- $config['mysql_db'] - your MySQL database name
- $config['uri'] - URL of your website including the trialing slash, e.g. http://eggblog.net/demo/
Change permissions for the following to read, write and exectuable (chmod 0777):
- /config.php
- /photos/full/
- /photos/category/
- /photos/thumbnail/
- /photos/uploads/
Open your browser to http://www.your-server/eggblog4/upgrade_3to4.php
Delete /install.php and upgrade_3to4.php
If you are running apache web server, you can use the .htaccess file to autoamtically redirect visitors to your new website:
- Edit .htaccess_3to4 and change http://www.your-domain.com/eggblog4/ to your new url
- Rename .htaccess_3to4 to .htaccess to automatically redirect traffic to your new pages.

Language Pack
eggBlog supports the use of language files, enabling you to run eggBlog in a variety of languages at a single click.

Download the latest language pack and extract them to your eggBlog installation; i.e. all language files (e.g. en_gb.php) should be in the /lang/ folder.

Administration
On installing eggBlog, you will be given your administrative email address and password.

On logging in, you are presented with an "administration" link as shown to the right. Clicking this will take you to the administration options from where you can:

Configure your website
Add a new article
Add a new photo album
Add a new photo
Edit registered members
Check for updates

Editing and deleting photo's, forum topics/posts and articles can be done directly from the item itself using the "Edit" and "Delete" links.

Templates
Templates can be used to include HTML on all pages. These are safe guarded against future upgrades meaning any eggBlog updates will automatically include your custom aditional HTML.

Templates - Sidebar
Any HTML you would like to include at the bottom of the sidebar should be saved as HTML as /_lib/inc_side.php. This file can include PHP where required.

For example, to include the SourceForge message as used to the right of this website, the following text makes up the /_lib/inc_side.php file:

<div class="box">
<strong>Sourceforge</strong>
<p>Download bandwidth is kindly supplied by <a href="http://sourceforge.net/projects/eggblog">sourceforge.net</a>.</p>
</div>

Templates - Footer
The same can be done for the footer to run javascript based statistics by placing HTML in /lib/inc_foot.php.

For example, to use Google Analytics on eggBlog, I need to include the following text in all pages before the </body> tag so I simply copy this text into /_lib/inc_foot.php: