The Manual
P2/65
French version also downloadable at http://www.freeguppy.org Document realised and exported in PDF format with OpenOffice.org (v2.1fr) This document is subjected to GNU FDL licence. That means that it is free of rights. You are allowed to distribute and modify copies of this manual as long as this note clearly appears and as long as GNU FDL licence is respected. For more information on this licence, see appendices of this manual .
P3/65
Contents
GUPPY................................................................................................................................................... 1 CONTENTS............................................................................................................................................ 3 USE OF THE MANUAL.......................................................................................................................... 5 INTRODUCTION ................................................................................................................................... 6 THE GUPPYLOOK ............................................................................................................................ 7 HOW TO FIND AND INSTALL GUPPY................................................................................................. 8 WORKING WITH GUPPY IN LOCAL................................................................................................. 9 SETTING OF PARAMETERS.............................................................................................................. 13 MANAGING THE CONTENT OF GUPPY............................................................................................ 31 ABOUT PLUGINS................................................................................................................................ 40 UPLOADING GUPPY ON LINE........................................................................................................... 41 WORKING ONLINE............................................................................................................................. 44 PORTAL MANAGEMENT.................................................................................................................... 48 ACKNOWLEDGEMENTS.................................................................................................................... 49 THE MOBILE FOLDER.................................................................................................................... 50 APPENDICES....................................................................................................................................... 51 TABLE OF CONTENTS....................................................................................................................... 63
P4/65
P5/65
0
Use of the Manual
This document aims at being a manual for the initiation of GuppY. It is not necessary to carry out a linear reading of this manual. Chapters and contents (located at the end of the document) allow you to navigate easily. However, if you are beginner to GuppY, it is highly advised to follow the manual "step by step" in order to measure well all the possibilities, all the power of GuppY. All the terms marked with an asterisk (*) are included in the lexicon. The listing of modifications made to the present manual for its passage from the v4.5 to the v4.6 are given in appendix. Read attentively this documentation as well as the "Read-me" file provided with the software before posting any request on the GuppY Forum (http://www.freeguppy.org/). Indeed, more than 90% of the questions posted there have their responses in these two texts. Although being the principal writer of this manual, nothing could have been done without the assistance of the formidable GuppY Team . I also wish to point out that the drafting, page-setting and exporting in "pdf" format were made thanks to OpenOffice.org (version 2.1 -fr under Linux Ubuntu 7.04 Feisty Fawn) which is a free productivity suite, complete and tremendous for its simplicity and its effectiveness. GuppY is used in the whole world ! Here is the geographic coverage on February 2005 :
P6/65
1
Introduction
1.1 An extract of the "Read me" file
GuppY is a Web portal* which does not require a database to run . This thus makes it possible to install it on all Internet hosts (or almost), the only need is that your host provides you the PHP script language service. There is no need to know the HTML language, nor SQL database config, nor PHP; GuppY offers an interface of complete and protected administration to manage the appearance and the contents of the various elements of your site.
GuppY proposes the whole of the traditional functionality of a Web portal :
news articles links directory download section diaporama of photographs guestbook forum FAQ poll visits counter click counter newsletter administration area optional member zone different administration etc.
But, GuppY brings an original management: in more of being multi-language, GuppY offers an optional presentation of the bilingual contents, with a choice of 2 languages to display.
P7/65
2
The GuppYlook
The header includes the various essential icons with the correct operation of GuppY (the admin icon, located at the extreme right-hand side of the header presented below which is only one example among many possibilities - is not showed here):
A click on one of these icons brings you to the corresponding page (note that the names of the icons should not obligatorily appear in it, this can be modified). The boxes can be laid out freely in various places of the page (note that you can choose to activate, and thus to display or not these boxes ) Lastly, GuppY is entirely " skinnable " : equip it as good as it seems to you and do not hesitate to go to GuppYLand (http://www.guppyland.org), a satellite site of the official one. You will find there all that you need (and even more) to change the appearance of your GuppY.
P8/65
3
How to find and install GuppY
Only one address, the official site : http://www.freeguppy.org The GuppY file: guppy.zip of ~2400 Kb The file of the languages (essential if you wish to manage other languages than French and English): Guppylang.zip of ~700Kb ). When GuppY is downloaded, you have to unzip it in a folder of your hard drive (for the lang file, have a look at its Read-me file) Pay attention ! If you download EasyGuppY (see next page), GuppY is already present in this package (check its version number anyway: sometimes a new guppy file is produced, as for example after a correction, without changing the EasyGuppY package). Two options are then bringing to you : working with GuppY in local on your PC or on-line on Internet. Personally, I highly advise to test initially GuppY in local. It will always save time, when the site is at the point, to put the whole on line. Consult also the "step by step" cards of Laorens on GuppY-Education. (http://guppyed.org/).
Users of Macintosh and Linux (I cannot help using it !) are not forgotten: a special section for them is available at the end of this manual.
P9/65
4
Working with GuppY in local
For that, it is essential that your computer could manage the PHP language. Fortunately, the team of GuppY is, once more, here to help you with EasyGuppY. This kit of development (including three software : BRS WebWeaver, PHP and GuppY) makes it possible "to transform" your computer into a local Web server. It runs under Win 9x, Me, NT, 2K and Xp. (See you at the end of this manual for a local use under Linux and Mac) But do not panic, there is no need for knowing oneself the configuration of PHP GuppY and EasyGuppY take care of all !
P10/65
Your browser opens then a banner page and a click on "Launch GuppY " opens the very new GuppY. However, if you placed other GuppY in the adequate directory, or folder (i.e. C:\Program Files\EasyGuppY\www \), they will also appear in the window and a click opens the corresponding GuppY (very useful to work with several Web portals).
Note : once Easy GuppY launched, an icon is placed in the task bar near the clock. A right click gives you access to various menus ("Exit" makes it possible to close EasyGuppY).
In our case, we will use GuppY that we will have installed in the www folder of EasyGuppY. Do not hesitate to use it as a bench test and preserve it, you will use it thereafter as a zone of test. There once at the point, create a new folder in "www " and place new GuppY which will be the base of your official portal.
P11/65
P12/65
A good working method consists of using the tabs of the browser (I advise you to use Firefox) in order to have two fields of work : one for working in the admin, the other to see the changes (so refresh this second tab to see them).
P13/65
5
Setting of parameters
This is done within two main areas : Area 1 : Skin Configuration
P14/65
create a sub-folder in the \inc\img\ folder (as example in the GuppY _ icozerg folder created for the occasion : C:\Program Files\EasyGuppY\www\GuppY\inc\img\GuppY_icozerg\ ; there place 12 images named admin.gif, blog.gif, download.gif, faq.gif, forum.gif, guestbook.gif, home.gif, links.gif, news.gif, photo.gif, react.gif and stats.gif (! the name matters, the extension must be .gif and the size is imposed : 32x32) ; it only remains you to choose the adequate name in "icons theme" and GuppY will be given the responsibility to place icons at the good places.
P15/65
add the number with "px " (that indicates the unit, i.e. the pixel*). The method does not matter, the major disadvantage residing in the fact that the size of the posted text is imposed to visitors, since it is fixed. Consequently, only those using the standards sizes provided by the browser will fully benefit from your pages. The others, those which do not use the usual sizes(partially-sighted persons, for example, who use larger font size) will be penalized because their posting will be brought back to too small sizes for them (yes, since you impose the size!). It is wise to choose a font of a relative size, i.e. likely to be increased by your visitors and adjustable with their own way. Then prefer the sizes specified in points (Pt), expressed as a percentage (%) or in em. In addition, a size of 14 points seems to be the acceptable size minimum by the partially-sighted persons. Be all the more attentive there as they are numerous to surf on the web.
P16/65
... and to select the position of the lateral and central boxes of the skin in use.
This is an innovation of this version : boxes are skin co-dependant. So, according to the appearance you choose, the position of boxes may change. Whereof making a very personnalized GuppY !
P17/65
Generate creates the style sheet of the skin from a standard list and from Look Config datas (Here, we have modified the no-skin skin previously selected) :
Modify style allows you to rewrite this sheet or a personnalized existing one. ! Use this only if you perfectly master the CSS language !
P18/65
P19/65
The copyright
GuppY is under CeCILL free licence. The copyright appears on all pages. You can only modify the size and the position of the logo, or decide to not show the logo (but the text will stay in place).
Be respectful with the work provided by the GuppY TEAM and do not try to mask this copyright !
Indeed, by hiding it, not only you will not respect the licence (see next paragraph) of the software, that is reprehensible, but especially you will show disrespect to our team which, I point out it, consists of voluntary workers offering their spare time to offer a product of quality to you. Here is an extract from the judicial CeCILL service about the copyright mention :
By downloading the software, the licensee commits to respect the terms of the CeCILL licence and especially those related to its article 6.4 imposing the licensee to reproduct to the identical the mentions of intellectual property concerning software's copies. You have the right to impose to this licensee to inscribe on all software reproduction the mention Site runnning under GuppY v...- 2004-2006 - Licence Libre CeCILL. If the licensee does not comply with these terms, you can send him a letter asking to suscribe the legal mention on each software copy. In the absence of rectification within 30 days, you can resiliate his licence. So, this user will not be allowed to use, modify or distribute the software (Art. 10 licence CeCILL). More infos here : http://www.cecill.info/licences.en.html
Description
This tag declares the main language used by your Web site. It is very useful as many anglophone search engines include the language in their search criteria. The search engines strongly pay attention to the title of the documents. The error not to be made: do not give to your page the title "home " or "index ".
Description
Phrases taken care by the search engine like description of your site. The words, which constitute this sentence are also regarded as keywords by the majority of the engines. Numbers maximum characters: 200. Avoid phrases that aren't significant. Indicates to search engines the keywords related with your site. Place your most significant keywords at the whole beginning. Your keywords must be separated by commas (Example : html, xml, java, ...). Maximum numbers of characters: 500. Do not hesitate to use expressions (Example : html guide). You can alternate keywords of French and English language. You can register the significant keywords of your site in capital letters and in small letters.
Keywords
P20/65
TAG
Identifier URL
Description
Do not repeat several times of continuation the same keyword. This tag makes it possible to indicate the URL of the site. Ex. http://randorous.free.fr/ It takes again the principal address defined in the file of configuration of GuppY. Avoid the typing errors Allows specifying the folders to be referred or exclude for the robots (spiders) from the search engines where you referred yourselves. All ? indicate to the robots to index your pages and to follow the links of one page to the other. Index ? The page will be indexed by the robot. None ? Indicate to the robots not to index your pages and not to follow the links. No Index ? The page will not be indexed by the robot. Follow ? The links contained in the page will be indexed. No Follow ? The links contained in the page will not be indexed. The most used solution ? Index, Follow Allows to specify with the spider (robot of the engine) to re-index your site according to the interval in days given. Never write "1 day"? 14 days is the minimum. Allows identifying the author of the site. Your name in capital letters, your first name in small letters. You can, if you wish it, put several authors (separated by a comma). Only the Nomade engine indicates the name of the author. This tag indicates the name of the site owner. This tag indicates the principal e-mail address of the site author. It allows the Net surfers who have recorded your page to contact you. Avoid the typing errors !!! This tag is an open door to the Spam, these advertisements and other viruses which encumber your mailbox. Inform this tag only if you are fully aware of what is the Spam: your e-mail will be reproduced on the search engines but your mailbox will be saturated with poisonous mails. Note: keep e-mail in the box "Webmaster Info , there you do not risk a lot. This tag makes it possible to define the public concerned. You can choose between General, Mature or Restricted. This tag indicates if the document is widely diffused (Global) or restricted (Local). Allows specifying the copyright of the site. => implicit concept with the use of any document present on the web but alas not enough presents in the spirit of many Net surfers. ! Respect the copyright, respect the authors! You can put several names (separated by a comma). Allows specifying the category of your site, useful for certain engines which generate a classification by categories. => not currently present in GuppY.
Robots
Owner Reply-To
Classification
P21/65
5.6.1 Management
It is here that you will carry out administrative choices such:
Quick access to articles Admin ; the choice between the standard editor or FCKeditor :
the displaying or not of the "admin " button (warning, if it is not displayed, you will have to add "/ admin" to the URL of your site to reach the zone of administration: http://www.mysite.com/admin/) ; the activation of collaborators. This will be detailed further.
P22/65
A click on the arrow located on the right unrolls the contents. It any more but does not remain to click on the article wished to see it to post itself.
P23/65
Supervision e-mails: you can receive supervision mails for different events : to be warn for a new post on the forum or the guestbook, a newsletter unsubscription , the posting of a news.... However, this service only runs with hosts that allow it (it is often deactivated on free hosts). Then select carefully the email function as some host have a specific version of this function : be informed by them if you don't know which one to use. Otherwise, test the different functions and check for email. If you do not receive a mail, then your host doesn't allow this function . Anti-spam system : Guppy includes an anti-spam system that prevents from receiving this non requested mail (the spam is the action to send electronic mails (e-mail) with an advertising or promotional aim, which they are commercial or not, and in general in great number, with people who did not request it by using mails that appears in forum, guestbook...).
The maximum number of memorized code shows the quantity of malicious codes that the antispam data file has to memorize. (minimum 50); The Period of validity of a code in minutes corresponds to the time while a code is remaining in this same file before being replaced by another one (10 minutes minimum). So, if an user sends a script in a post to the forum, this command will be memorized for at least 10 minutes (see the upper illustration ). Then if it's a script that is sending a flurry publication, every post including this script won't be allowed to be posted.
RSS cache management : You can manage the duration of the RSS cache. This cache makes possible to display "news" published on a friendly site. The duration of the cache is the time after which a "checking" will be carried out on the friend's site to see whether news were published or not. The choices of time are 15', 30', 1h, 3h, 6h, 12h or 1d.
P24/65
If a box remains empty, the name of the corresponding section will not be posted. Useful not to post the texts below each icon (reception, news, stats).
Write and display the forum charter To display it on fullscreen or two columns mode To choose between one or more discussion categories (with the number of each one, no more than 12) To display an icon new for a new thread (and to select, in days, the duration of displaying it) To maintain a thread on top (in hours), that's to say as the first thread seen by users. To maintain a thread on top (in days), that's to say as the first thread seen by admins.
P25/65
Of course, it is necessary to be member and author of a post in order to manage this kind of modification (those seen upper, but the possibility to preview a post, to modify it or to lock it too) For sure, only the admin has higher authorizations than the ones of the user. Then, he can manage all the posts of a forum, including the possibility to lock it (that's to say that no one can add an answer). It is also possible to select the scale of number of messages that makes the difference between constant and occasional users.
! Do not forget to save your changes with the Save button that is just below these two windows. The same button that is placed bottommost only corresponds to the discussion categories section ! The second form available in the Forum config let you name each categories :
! Do not forget to save your changes with the Save button that is just below this window.
P26/65
You will activate this option while notching Management with members area (in Config member area). Select then the sections whose access will be reserved to members only: a notched box means that the access is forbidden to the no-member visitors. You also have the possibility to remove a member and to write a message to all your members.
5.12 Permits
It is here that you create or modify the rights of access of your collaborators (! avoid creating a form for your pseudo of admin!), or that you remove a collaborator. Only a registered person can get this permission.
To register, just complete the field of the Preference box and click on send . Then, complete the new fields (memorize your secret code !) :
P27/65
Start by choosing a collaborator among your recorded members. You end then to a window allowing to allot or not certain rights of access: a ticked box = right of access. (Avoid to use your admin login to complete such forms, being an admin already give you all rights !)
When you are connected as a member, a click on the admin button leads you to the following window :
When logged, the collaborator will only have access to what he has been allowed to :
P28/65
5.13 Password:
For obvious reasons of safety, change the password of administration provided by default (for recall: it is "pass "). Do not forget to disconnect you at the end of the session from work. Thus, the following user of the computer will not be able to touch there. Note well that the password is automatically deactivated during the closing of the browser.
If you forgot your password, you still have the possibility to upload again the mdp.php file via ftp : the default password is then set again (pass), you just have to change it !
P29/65
It stops when it have controlled the totality of the documents. If you click on "Launching the database integrity check in BATCH ", no need to enter the numbers of documents, control will be carried out for all.
It is in any event salutary to launch a control of integrity from time to time, even if none of the misalignment symptoms appears in an obvious way. In fact, as soon as a problem disturbs your portal, make turn a control of integrity, whose repairing virtues are well-known.
5.15 Maintenance
This page makes it possible to remove definitively or to restore in inactive status (it will thus be necessary that you think of reactivating the restored elements) the contents (articles, news) which you previously chose not to use anymore in the other sections. You can visualize the contents in question, to restore it if you changed your mind or to definitely destroy it. Caution: the destruction on this level is irreversible!
P30/65
5.16 Working
Sometimes you may have to deeply work on your website. It is then ??? worth to set your website offline for a certain time. The Work section was made for it : being a member and having the rights given by your admin, you are allowed simply to place the site under working (do not forget to deactivate it as soon as you have finished your work) Your portal will be then unavailable to visitors :
5.17 About
This page informs you about the software and its authors.
P31/65
6
Managing the content of GuppY
6.1 The running principle of GuppY
GuppY runs using the PHP program language (Hypertext PreProcessor). Its running principle is relatively simple: the contents (stored in a small "text "database ) are separated from working (managed by PHP scripts). It is what one calls CMS (Content Management System). Thus, it does not have to trouble you any more about management and presentation: you enter information and GuppY takes care of the remainder (unlike a traditional page HTML where the least modification of aspect, for example, must be reflected on each page of the site).
P32/65
6.2.5 Notice
In the shown path (C:\Program Files\EasyGuppY\www\\file\), the 3 points (\\ ) represent the folder in which you work. Thus, the complete path will be for example: C:\Program Files\EasyGuppY\www\GuppY\file\
P33/65
P34/65
Area
Homepage News Articles
Function
When the visitors arrive on the homepage, it is this text which they will see. It is a good idea to modify it from time to time Manage here the news of your site. Do not forget that the number of news posted on the banner page is defined in " homepage config ". Manage your articles here. Tips: the articles are posted initially by category then by title, always alphabetically. Also you can number them to arrange them in the order which you wish. You can improve the presentation of your articles using HTML tag (although that is not at all essential). See in chapter 6.6. Manage here the messages left by the visitors in reaction of your articles. Do not hesitate to remove the sentences which do not follow the "charter of the Net" ( racist matter, abusive, coarse words). When the visitors arrive on the banner page, it is this text which they will see in the Spcial box. Manage the photographs here. Manage here the files which you want to offer for download to your visitors. It is strongly recommended to store them in the file folder (via the icon of Files administration). Manage here the links towards other sites. Possibility to create categories. FAQ stands for 'Frequently Asked Questions'. In short, it is here that you put the play of questions/answers which arrives to you regularly. Possibility of classifying the FAQ by categories. Manage here the messages left by the visitors on the guest book of your site. Do not hesitate to remove the sentences which do not follow the "charter of the Net" ( racist matter, abusive, coarse words). Manage here the messages left by the visitors on the forum of your site. Do not hesitate to remove the sentences which do not follow the "charter of the Net" (r racist matter, abusive, coarse words). Manage a forum containing up to 12 subjects of discussion. Manage a poll up to 10 answers! The free boxes are additional boxes (four). Manage here the commercial banners which will appear in top of your Web pages. A banner is taken randomly with each page displaying. The "Flash " format is now supported. Manage here the quotations which will appear in top of your Web pages. A quotation is taken randomly with each page displaying. Tips avoid the jumps with the line in the quotation which will lower as much the height available for the remainder of the site. Try to make hold the quotations on only one line, as short as possible. This piece of page will appear in bottom of all the pages. You can follow and read here the messages of recommendation sent by the visitors of your site with their friends. Manage your counters here (reset to zero, boost them) Allows to visualize the frequentation statistics of the site and their analysis. Possibility of purging the statistics (reset to zero). This page gives access to the various phases of preparation and sending of your Newsletter (list of the subscribers, to write Newsletter and to send Newsletter). This one can now be sent to HTML format.
Guestbook Forum
P35/65
Area
RSS news
Function
RSS stands for Really Simple Syndication. You can manage here the publication of contents of partner sites which manage this standard publication format, like GuppY does for the news. You can configure (a number of logs, pages to be supervised) or visualize your logs, i.e. to follow accesses to your site (date, hour, IP address of the visitor, URL of source, country, host/robot, browser used). If your host allows it ( Ask your host about it), you directly send from your computer to your site (= upload) images, photographs, without using your ftp client. Choose a date and write the text of the event. The box "Calendar" underlines then the current date concerned. A click on a date displays the event on central page. There you can manage your blog, and add a note. Manage comments posted by the users of the blog. You can manage here the publication of partner's website content that use this standard publication format, as GuppY does for the news.
No : is the old editor (only for Internet Explorer) that runs in a popup Yes, FckEditor : It's FckEditor that directly runs Popup FckEditor : FckEditor runs in a popup by clicking on a button.
FCKeditor is a WYSIWYG editor that automatically changes all that is written to XHTML correct code. As a consequence, you can easily write and manage your article as if you were using a classical text editing software.
P36/65
FCKeditor is compatible with Mozilla, Firefox, Netscape and Explorer browsers . Moreover, it offers the possibility to insert Flash code. Take care, FckEditor works correctly only if URLs are correctly input in admin |General Config.
P37/65
to increase the number of headings and to put less articles by heading; to use a really alphabetical classification: letters instead of figures (A, B, C). That nevertheless leaves you a margin of 26 articles. to number your articles from 01 to 99 (for less than 100 articles), or from 001 to 999 (for more than 99 articles) It is a solution satisfactory, but not very gracious.
The disadvantage of these operators of classification is to occupy width space in the already narrow articles boxes. There is a miraculous alternative solution, puffed up by a Russian speaker on the GuppY forum: it consists in masking classification with comments tags <!-- 01 -->, <!-- 02 -->, etc. The classification takes place thus in writing pad and it will not appear with the screen. The same solution can be used to treat on a hierarchical basis the articles categories: attention, because it is then necessary to reflect the number of classification encapsulated in the tag of comment in each article present in the category, and not to only one item.
P38/65
Different categories can be created by the admin. Of course, in each ones you can post notes.
Notes will be classified in such a way that the most recent one will be on top. Displaying a note let the possibility to post a comment. Use your pseudo, an email and write the comment, then click on Send. The webmaster can delete a comment if needed. Visitors can submit a note (Post a note button): use your pseudo, an email, choose a category and give a title to your note. When posted, a message will warn you that your note will be published as soon as the webmaster validates it.
P39/65
Last notes
P40/65
7
About plugins
GuppY is provided with some very simple plugins for example: Clock, Mind (= Riddle) and Speed. You will find more details on this subject and a crowd of plugins to be downloaded on GuppYLand (http://www.guppyland.org) Attention, it is appropriate to check well the version of GuppY to which the plugin is attached. Some are not compatible any more with the new version (but will undoubtedly be very quickly, the developers of plugins being very active). In all the cases, always read attentively the "Read me " file who comes along each plugin. That will avoid you getting many problems.
P41/65
8
Uploading GuppY on line
8.1 Web host and PHP
First of all, it is necessary that you check whether your host manages the PHP script language (if you doubt, ask them about it ). Possibly, it is necessary that you activate the PHP, because certain hosts do not activate it out of standard. Check this with your host.
Unzip files on your hard disk ; Transfer the whole of them to your Web space ;
Check, using customer ftp, if files contain well all your data (thus no file with 0Kb apart from the files which are 0Kb originally, namely: SEE on the forum of the official site). It happens indeed that the transfer is stopped or corrupted: you will then have error messages of the type : Transfer cancelled, critical transfer error, Too much tries... But sometimes, you will not be warned that the transfer was degraded. Errors will appear then on your site, without understanding why. Where to put the files ? Either you can put all the unzipped files and folders at the root of your site directly. Your GuppY will open with the address http://www.mysite.com. Or you can deposit these same contents in a folder, "GuppY /" for example, of your Web space: in this case, your GuppY will open with the address http://www.mysite.com/GuppY/
P42/65
8.3 Checking
It does now remain for you to open the browser , to connect you to the network and enter the address of your site (yes, GuppY knows it since you enter its general address in "admin | Config "). Your first task will consist in modifying the default password which gives you access to the administration of your site.
8.4.1 Chmods
Chmods are permissions you install on files and directories , which constitute the whole of your GuppY site. They indicate which tasks are authorized, and this for each file of your site. If Chmods are badly set up, your online GuppY will malfunction and will return to you with error messages of this type: Warning: fopen("data/logh.dtb","w") - Permission denied in http://www.mysite.com/inc/functions.php on line 198 You chmod with your ftp client (the procedures depending on your ftp client, consult documentation relating to this task ). Here are the rights to set up on the files for the Internet server which require it (not all, for example, one chmod not at Free). 1. CHMOD data/archive/* 666 (the asterisk indicates that you chmod the files contained in archive/ folder ) 2. CHMOD data/archive 777 (here, you only chmod the folder archive/) 3. CHMOD data/cache/* 666 4. CHMOD data/cache 777 5. CHMOD data/usermsg/* 666 6. CHMOD data/usermsg 777 7. CHMOD data/* 666 8. CHMOD data 777 9. CHMOD admin/mdp.php and action.php 666 ou 777 10. CHMOD admin/redac 7777 11. CHMOD skin/ 777 12. CHMOD skin/name_of_the_skin 777 13. CHMOD skin/name_of_the_skin/* 666 To learn more about chmods, consult the complete tutorial on the official website.
P43/65
8.4.2 Security
!!! As soon as your site is online, REMOVE INSTALL/ folder . If you omit to do it, your site could be emptied during 1 second by carrying out the script of installation. That happens only to others but the destiny see it differently ... and today it is your turn ! Your site is disfigured by a hacker. Be happy he could have erased its contents! Do not try the devil! The prevention is a good reflex to acquire. GuppY is a product developed in PHP, which enables it to be fast and interactive, but it can leave open exploitable faults by badly disposed people How long did you conceive your site? two days, one week, one month ? One will not have more than 30 seconds to an average hacker to reduce to zero all your efforts! That gives matter to reflection Protect your documents, the access to your site administration and certain sensitive contents , using " htaccess " protection . Consult the heading "Make safe your site " on the official site. !!! The security is not to take with the light one, and this some is the size of your site. The examples of "visited", "damaged" or "destroyed" sites are unfortunately numerous !!! More information of safety on the excellent site CyberMdiaConcept of my friend B@lou (in French ):
Whatever, your host can provide you good advises ! Indeed, in this domain, each one follows its own way, so do not hesitate to ask them about htaccess security and more. Moreover, there is no perfect security, but it seriously complicates hacker's tasks. Then, never forget the golden rule in informatics : BACKUP FILE = SAVED FILE !
P44/65
9
Working online
9.1 Online? Did you say "online" ?!?
Yes of course !!! And it is even the most interesting function of GuppY! Imagine for one moment you are somewhere, anywhere but not on your premise. And it is necessary for you absolutely to add an element to your Web site. There is not to discuss, it is too significant and that must imperatively be done. But how ? To go back home? Pfff it is too far, I do not have time No panic, you find a computer connected to the network and hop, it left! It is enough to go to the address of its site, to click on the "admin" button , to enter its password and miracle! You can with leisure modify your site, to add elements to it Brilliant, isn't it?!? Of course, do not forget to disconnect you after your work ("disconnection" button of GuppY), otherwise the following person will have access to the administrative part of your portal and will be able to thus modify it !!! Tips: if you have a slow modem connection, do not hesitate to prepare your article off line (using the Notepad of Windows , for example). It will not remain you whereas with the "copy/paste" online. Important note: GuppYest a site which lives in real time by the additions in the guest book, the forum, the recommendations with a friend, the counter of visits, proposals of news This is why we recommend to build your first GuppY locally, to put it online, then to carry out all the later modifications online.
P45/65
The button "Prepare your GuppY " causes to display a new screen in which is necessary to click on "Go ", then to choose "Clean Install " and follow the instructions. Here, now you really use YOUR GuppY! Warning, this clean installation does not modify your password. This one is crushed only when one reloads or replaces by ftp the file "/ admin/mdp.php " (this procedure enables you to recover your "admin " access if you forgot your password but finally, try to remember, it is more practical).
P46/65
P47/65
P48/65
10
Portal management
A maintenance? But for what? Well, a site which does not evolve (very) quickly becomes a site which disappears. Indeed, think of your own experiment of surfing on the Net: do you often turn over on a site which does not change months since? Well...Not ? And well here, you have the answer to your question: make live your site and the public will return it well to you while coming to visit you regularly.
Work is now facilitated to you by the fact that GuppY integrates an option of maintenance. This one enables you "to freeze" the portal throughout your work. You must be recorded as member to put the site in maintenance.
P49/65
11
Acknowledgements
11.1 Thanking the author of GuppY and its team
For sure ! Laurent Duveau did a remarkable work, and it makes a free and free software of it. Is that worth a thank, isn't it?!? Start by visiting his personal site then leave him a message in the guest book, that always given pleasure (http://www.aldweb.com). Other developers worked like has navvy for this new major version. Consult without more delaying the window "About" of your GuppY to know the characteristics of them that do great stuff. Beside, I want to send a great THANK YOU ALL !!!. Let us not forget the abstract team which is given without hoping to offer a software increasingly more powerful to you and which answers your waiting always more. All this small world can be finds on the official site of GuppY. You will find there their names (or nicknames), the address of their own site and they also like to receive a small word in their Guest Book ;-) Thanks to all members of the GuppY Team
P50/65
12
The mobile folder
GuppY is provided with a mobile version, with reduced displaying. This one is particularly intended to our friends who are partially-sighted persons, but it will make also the happiness of the owners of PDA. Adapted to the partially-sighted persons? Yes, because those often use voice synthesizers which reads the page from left to right and convert the writings into audible sounds. The difficulty is that the basic structure of GuppY comprises boxes, banners What disturbs the synthesizers which read pieces of sentences of each element (they go from left to right and do not make the distinction of a change of box). The mobile version circumvents this aspect of the problem while bringing back the contents in only one and even page perfectly usable by the vocal computers. The link towards this version is now integrated by defect in the "Webmaster " box. If this box is deactivated, it will be enough for you to use the additional sub-directory "mobile/" with the address to your site: http://www.mysite.com/here/mobile/ In this case, you will largely facilitate the task of the visitors by creating a link, accessible on the banner page, driving at this address.
P51/65
13
Appendices
13.1 The Preferences box
If the " Preferences " box is activated, each visitor can become the member of the site. That confers many advantages to the member: : his or her pseudo and e-mail is retained, which avoids to him or her having to seize again them with each post; it automatically arrives in the language which is chosen when the site is bilingual; it positions the boxes with its liking; it selects the skin of its choice to sail on the site; it has a personalized signature, an avatar and an URL which will be added automatically to its posts on the forum; finally, it can receive and send mini-messages (in particular via a module of mail posting the messages read and not read).
You can personalize your secret code (5 characters minimum) and use this one to re-register you with the same name (or pseudo) or to use your name (pseudo) on another machine. The only condition of inscription is that the browser of the visitor accepts the "cookies *" (this option is adjustable in the browser parameters).
Note : the cookies are stored only on the computer of the recorded user, it thus does not have there a possible constitution of lists of members: no possible recovery = respect of your private life !
13.2 Compatibility
Linux, Windows, Mac OSX, QNX, BeOS.. GuppY adapts to all !
P52/65
In more of the traditional one Internet Explorer, GuppY easily functions under other browsers such as Mozilla , Firefox, Galeon, Konqueror, Safari and Voyageur.
Did you see what the elephant can do !!! Personally, I cannot do but this is not the subject here. This step is the most important as you may know that Macintosh has recently provided to the market computers with new chipsets and new structures . These new macs are known as Mac Intel. Before this event, all where known as PowerPC (PPC). So choose carefully the pack corresponding to your Mac or it won't run. 4. Then, lets' go for the download....
P53/65
Then you could have an automatic window, if not, just double-click on the icon. 6. You will now see this :
Then drag&drop the MAMP folder picture onto the Applications one. 7. You should then see this :
As soon as the copy is over, you will be into the Applications folder
P54/65
8. Now you will have to place your GuppY folder (with all files and folders). Just open your MAMP folder and you should have the following :
Then, open the htdocs folder and copy your GuppY folder as shown below :
P55/65
1 Go to the MAMP folder (in Applications) and double-click on the MAMP icon to run the application.
2 Once launched, the following window shows up : Wait for the two spots to be green.
Note : sometimes you will automatically be on the home page, so wait a little... 4 The Home page should look like this :
P56/65
You might see a strange URL on top : http://localhost:8888/MAMP/?language=French. Don't be afraid, http://localhost means that your are on your local host and the 8888 number is your host port. Indeed, your address will always begin with: http://localhost:8888/. Then complete it with the name of your folder placed within the htdocs folder. As for example, we have placed GuppY in the htdocs folder, so we write the URL like this :
5 Then press Enter and look at your wonderful GuppY ready to be used ! Note : you can place many GuppY in htdocs. Just create many folders, like guppy-daddy, guppy-mummy, guppy-kid, etc. Then write it in the URL : http://localhost:8888/guppy-daddy
13.4.1 Installation of a Web host, Apache, Php and MySql with Linux
We have chosen XAMPP. You can easily find a tutorial on the net. Nevertheless , I pinpoint the Xampp stop process. Open a terminal and code the following : sudo /opt/lampp/lampp stop
P57/65
You should see this : Stopping LAMPP 1.5.5a LAMPP: Stopping Apache... LAMPP: Stopping MySQL... LAMPP stopped Xampp is now stopped.
Open nautilus in root mode (command gksudo nautilus) Display the hidden files (CTRL+H) Go to /opt/lampp/htdocs/ Right-click on it and choose New | folder Name it guppy
Right-click on guppy In the opening window, click on properties Make your choice as shown below
P58/65
Note : This is the note of the more adequate process. It seems that using a ftp software to place GuppY in the htdocs folder is a better choice. I didn't try it as I am the only user of my computer, that's why I can give all access to a folder.
Note : Gftp is include in Ubuntu Linux. You have to write 127.0.0.1 in Host and to choose nobody in User. For password, use lampp. At last, click on the connection button on the left in order to displaying the htdocs folder. Save with Bookmarks | Add bookmark.
Note : You can install as many folder as you want in htdocs, just name them differently.
P59/65
that any person has the right to freely use the manual. that any person is authorized to spread the manual. that whoever can modify the handbook freely by respecting GNU FDL licence (inter alia, the name of the preceding writers must be reproduced on any modified document).
For more information, consult : The Free Software Foundation (FSF) website which is at the origin of this type of licence : http://www.fsf.org. You can also contact them by traditional mail : Free Software Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Licence GNU FDL is detailed in a text file (copyright-gfdl) accompanying documentation at the time of its downloading. Read this licence attentively! For information and comprehension, a French translation of this one is placed at the disposal under the name copyrightFR-gfdl11 on http://randorous.free.fr. However, only the last English version has official value. The GuppY software is subjected to the CeCILL licence. You will find more details about this in the "readme.txt" file.
13.8 Lexicon
Alias: Object pointing towards another, to have access to this last from a moved place. E.g.: for the electronic mail, it is about an address created starting from an existing address, but which is entirely dependent on this one. It is in fact the same address, but under a different name. BATCH : File containing a whole of orders which will be treated automatically ("batch processing") as if they had entered to the keyboard by the user, one after the others. BLOG : Website where one or more people freely express on a certain periodicity. His or her expression is divided in chronological units; Each units can be commented and often enhanced with external links
P60/65
Compression: The compression of a file makes possible to reduce its size by mathematical algorithms (the most known format is the zip format). Decompression is the operation allowing the files compressed to find their initial size. Field: A zone of recording indicated for a certain category of data. A field generally indicates a white box in which it is possible to write. Ftp client: Software installed on a computer and allowing the file transfer thanks to the FTP* protocol . Cookie: Short character string deposited in a file of your computer by your browser W3. The "cookies" are especially used to store an permanent or temporary information (the date and hour of your visit, a response to a form which you filled on the visited site, personal information collected by the server, etc). Diaporama: A whole set of images that one can make ravel one following the other (~photorama). FAQ: Acronym for Frequently Asked Questions, heading presenting by subjects the questions most frequently asked by the users, accompanied by the corresponding answers. FTP: Acronym for File Transfer Protocol (protocol for file trasfer t), protocole Internet permettant aux utilisateurs dchanger des fichiers entre ordinateurs. Identifier(or login) : Name of user or identification number to be identified on a server. To increment: to increase by definite steps (E.g.: by step of 1 : x ; x+1 ; x+2 ; etc.). User Interface : Visible part of a software by the user, in other words the program managing the interaction between the machine and the user. Script language: Shortened programming which allows experienced users to create on their computer rich contents and which offers to the programmers rapidly to create simple applications. MySQL: System of management of relational databases very much used to put online databases. Package: A package is a regrouping, on the same support, of a whole of elements. File containing software in a format allowing an easy installation (or a deinstallation). E. g.: EasyPHP official package. Interpreted pages: Pages "understood" and displayed by the adequate software (in fact, via the "local Web"). Pixel: Luminous not posted by your computer. Portal: A page of entry of Web site offering the maximum of links towards the various parts of this site or other sites. RSS (format) : RSS meant initially Rich Site Summary but the acronym is often interpreted like "Really Simple Syndication" (one speaks in general about "syndication of contents" to indicate the possibility of republishing on a Website of the contents coming from another Website). RSS is a means of posting the news published on a friendly site. Script: A whole set of orders able to automate certain tasks of a communication program. Skin : a whole set of parameters and images defining the appearance of an application.
P61/65
Web server: Computer, or its software, which "serves" other computers on a network by managing the files and the operation of the network. Site Portal: It is a generic term to indicate a site which is used as entrance point on Internet for a significant number of users. SPAM: Spam (or spamming, pourriel, junk email) is the action to send electronic mails (e-mail) with an advertising or promotional aim, which they are commercial or not, and in general in great number, to people who did not request it. Tag: Specific codes used to format documents HTML Marks used in a text to announce to the program which specific order must be carried out. Download: Procedure aiming asking for and at transferring a file of a distant computer towards a local computer, then to save this file in the local computer. Upload: Procedure aiming at transferring a file from a local computer towards a distant computer (a server generally), then to save this file in the distant computer. Pixel: Luminous not posted by your computer. Portal: A page of entry of Web site offering the maximum of links towards the various parts of this site or other sites. RSS (format) : RSS meant initially Rich Site Summary but the acronym is often interpreted like "Really Simple Syndication" (one speaks in general about "syndication of contents" to indicate the possibility of republishing on a Web site of the contents coming from another Web site). RSS is a means of posting the news published on a friendly site. Script: A whole of orders able to automate certain tasks of a communication program. Skin : a whole of parameters and images defining the appearance of an application. Web server: Computer, or its software, which "serves" as other computers on a network by managing the files and the operation of the network. Site Portal: It is a generic term to indicate a site which is used as entrance point on Internet for a significant number of users. SPAM: Spam (ou spamming, pourriel, junk email) is the action to send electronic mails (e-mail) with an advertising or promotional aim, which they are commercial or not, and in general in great number, with people who did not request it. Tag : Specific codes used to format documents HTML Marks used in a text to announce to the program which a specific order must be carried out. Download: Procedure aiming asking for and at transferring a file of a distant computer towards a local computer, then to save this file in the local computer. Upload:Procedure aiming at transferring a file from a local computer towards a distant computer (a server generally), then to save this file in the distant computer.
P62/65
Page-setting of the manual was entirely reconsidered and allows a recto-back impression of quality. It is consequently possible to connect it (spiral, hot...) while preserving a perfect legibil In-depth modification of the structure of the manual : additions, modifications and removal of chapters, order of appearance of those modified... A Macintosh section added A Linux section added Summary integrated Summaries linkable Screenshots modified. Setting parameters section updated GuppY Editor section updated More details in the forum section New information about Blog Lexicon update Various little changes
P63/65
14
Table of contents
GUPPY................................................................................................................................................... 1 CONTENTS............................................................................................................................................ 3 USE OF THE MANUAL.......................................................................................................................... 5 INTRODUCTION ................................................................................................................................... 6 1.1 An extract of the "Read me" file..................................................................................................................... 6 1.2 What's news in this 4.6 version ?..................................................................................................................... 6 THE GUPPYLOOK ............................................................................................................................ 7 HOW TO FIND AND INSTALL GUPPY................................................................................................. 8 WORKING WITH GUPPY IN LOCAL................................................................................................. 9 4.1 About PHP......................................................................................................................................................... 9 4.2 EasyGuppY Installation................................................................................................................................... 9 4.3 Launching EasyGuppY.....................................................................................................................................9 4.4 Using the www folder......................................................................................................................................10 4.5 Keep in mind....................................................................................................................................................10 4.6 Configuring GuppY........................................................................................................................................ 11 SETTING OF PARAMETERS.............................................................................................................. 13 5.1 Theme Config...................................................................................................................................................14 5.2 Look Config..................................................................................................................................................... 15 5.3 Boxes config..................................................................................................................................................... 16 5.4 Generate CSS...................................................................................................................................................17 5.5 General management...................................................................................................................................... 18 5.6 Services Config ............................................................................................................................................... 21 5.7 Areas Config.................................................................................................................................................... 23
P64/65
5.8 Homepage Config............................................................................................................................................ 24 5.9 Forum Config ..................................................................................................................................................24 5.10 Forum archiving............................................................................................................................................ 26 5.11 Members zone managing.............................................................................................................................. 26 5.12 Permits............................................................................................................................................................26 5.13 Password:....................................................................................................................................................... 28 5.14 Integrity check............................................................................................................................................... 28 5.15 Maintenance...................................................................................................................................................29 5.16 Working..........................................................................................................................................................30 5.17 About.............................................................................................................................................................. 30 MANAGING THE CONTENT OF GUPPY............................................................................................ 31 6.1 The running principle of GuppY................................................................................................................... 31 6.2 You have four folders to pose the specific objects........................................................................................31 6.3 Management tools of the content:..................................................................................................................33 6.4 The GuppY editor........................................................................................................................................... 35 6.5 Activation service:........................................................................................................................................... 37 6.6 How to organize your articles:.......................................................................................................................37 6.7 The Blog Tool:............................................................................................................................................. 37 ABOUT PLUGINS................................................................................................................................ 40 UPLOADING GUPPY ON LINE........................................................................................................... 41 8.1 Web host and PHP.......................................................................................................................................... 41 8.2 File transfer (ftp)............................................................................................................................................. 41 8.3 Checking...........................................................................................................................................................42 8.4 Chmods & site security................................................................................................................................... 42 WORKING ONLINE............................................................................................................................. 44 9.1 Online? Did you say "online" ?!? ................................................................................................................. 44 9.2 Installing directly GuppY online....................................................................................................................44 9.3 The online version migration..........................................................................................................................46 9.4 Offline => Online content update.......................................................................................................... 47
P65/65
PORTAL MANAGEMENT.................................................................................................................... 48 ACKNOWLEDGEMENTS.................................................................................................................... 49 11.1 Thanking the author of GuppY and its team..............................................................................................49 11.2 Want to thank the author of this manual?..................................................................................................49 11.3 Thank you...................................................................................................................................................... 49 THE MOBILE FOLDER.................................................................................................................... 50 APPENDICES....................................................................................................................................... 51 13.1 The Preferences box.................................................................................................................................. 51 13.2 Compatibility................................................................................................................................................. 51 13.3 GuppY under Macintosh.............................................................................................................................. 52 13.4 GuppY and Linux..........................................................................................................................................56 13.5 File upload......................................................................................................................................................58 13.6 Sharing Web contents thanks to RSS format............................................................................................. 59 13.7 CeCILL Licence and GFDL......................................................................................................................... 59 13.8 Lexicon........................................................................................................................................................... 59 13.9 A little advertisement.................................................................................................................................... 62 13.10 Manual updates (v4.0 => v4.6)...................................................................................................................62 TABLE OF CONTENTS....................................................................................................................... 63