viewvc.cgi/nuke/INSTALL

PHP-Nuke: Web Portal System
===========================

Base Requirements
-----------------

In order to setup Nuke the folowing prerequisits are necessary.

A Linux Box (http://www.linux.org) Installed and working properly.
Apache Web Server (http://www.apache.org)
PHP (mod_php) Apache module (http://www.php.net)
MySQL database server (http://www.mysql.com)

The above doesn't mean it work with other configurations, OS's, DB's etc,
but we only provide INSTALL instructions for the above configuration.

Set-up of these required packages is beyond the scope of this document
and if you are unsure you should check with each of the appropriate web
sites for further details.

At this moment is known that PHP-Nuke has some problems working with PHP4,
when I have some money to buy a test machine to install in my LAN I promise
that I'll look into this to make it 100% compatible with PHP 3 and 4.


Installing the Package
----------------------

Unzip and Untar the package into the directory you want to use on you web
server, if you're unsure where that is, ask you system administrator.

tar -zxvf PHP-Nuke.tar.gz

Change to the sql/ directory and there is a file called "nuke.sql"
this file contains the commands to build the database structure, 
tables and the default data.

1) Create a database called, for example, nuke:

    mysqladmin create nuke
    
2) Now fill the databases with the tables in nuke.sql file:

    mysql nuke < nuke.sql
    
3) That's it!... now you need to edit the file "config.php", read the comments
for each option, and make the changes necessary for your installation 
when you have finished making your changes you are ready to launch your 
web browser.

Upgrading from previous versions
--------------------------------

    To upgrade a prevoius PHP-Nuke installation to this new version you
need to launch your web browser to:

    http://www.yourdomain.com/upgrades/upgrade1-25.php

    to upgrade from 1.0 and

    http://www.yourdomain.com/upgrades/upgrade2-25.php

    to upgrade from 2.0x
    
    all the new tables will be added and updated automagically without touch
your old data, then you need to reconfigure the file config.php to match
your site's info.


Testing the Installation
------------------------

Go to your homepage, for example:

    http://yourdonaim.com/index.php
    
To initiate your activities in your site, you need to login as Administrator at:

    http://yourdomain.com/admin.php
    
at the login prompt enter the following:

AdminID: God
Password: Password

    this will give you full administrator priviledges to your installation of Nuke.
For security reasons please remember to change the admin password and nickname 
"immediately". You can do this by clicking on the "Edit Admins" option.
    Remember to "Logout" from admin after you use it, from this area you can
delete or add content on your site, never leave your computer without logggin out
from the admin account. If something bad happens don't come crying to me.

    I recommend the use of phpMyAdmin. It's a good administration system for
MySQL databases. To download it just go to http://phpwizard.net/phpMyAdmin

    I also recommend to set a password for your MySQL access. This is important
as some data in the nuke database is not encrypted, so for security reasons you
need to set a password, not only that, it's good practice!

    For Banners System, when you setup a new client, you need to assign a new
login/password for him. The login and password is used by the client at the url:

        http://yourdomain.com/banners.php?op=login
        
    in order to let the client view and track the banners stats in real time
just pass that url to your clients. Take a look yourself before you do.


Theme Customization
-------------------    

        If you want touse any other included theme as the default theme, just rename
the "Default" folder in themes directory to whatever you like, and then rename 
any other theme directory to "Default". Also you need to add to the new theme 
the section in html for the users login. This section is in header.php file.

    That's it! You're done with PHP-Nuke. Just navigate around, play with it, 
abuse it and if you like PHP-Nuke, use it. Spend some time getting used to the 
administration interfaces.

    To change your site's logo, go to the themes directory and make a custom
logo for each individual theme. Just navigate around all themes and change
the graphics you want.

    A note for the PHP-Nuke site's administrators: Only admins (authors) can
view the following data in the site:

    - Administration Menu
    - Number of New Submissions
    - Edit button for each link in Web Links
    - Edit and Delete options for each Article
    - Delete option for each comment
    - IP/Host address of the comment poster
    - Moderation option and button (if set for admin only through config.php)
    - more in the future versions...

    I made this software free, and released it under GPL, so this software
costs you exactly "nothing". All that I ask you is, if you use it "please"
try to leave a link from your pages to http://www.ncc.org.ve/php-nuke.php3
and let others know that you're using PHP-Nuke. That's all I ask. If you
want to make me a donation, please contact me by email at fburzi@ncc.org.ve
I'll appreciate any money, books or new/used hardware you want to donate to me. I promise to improve this 
software and make more for web production.
    If you want to donate something without mail me, just send your donation to:
    
        Francisco Burzi C.
        Av. Principal Pueblo Nuevo
        Via Poligono de Tiro
        Casa # Z-1315
        San Cristobal, 5001
        Estado Tachira
        VENEZUELA

    If you send me any Windows related stuff you will be burn in hell, for sure! 
Send all you want for Linux, or anything that works in Linux.
    Finally, if you use PHP-Nuke in your site, please let me know and I'll put
a link back to your site from mine in the PHP-Nuke page. Ok?

    Enjoy this software!
    
PS: When you e-mail me asking something, just remember that I receive more
than 600 e-mails per day!!! so I can't answer to all you, but for sure
I'll read it. But please don't expect an answer if your mail is a question
about how to do this or that.

Due to a lot of emails I received I want to say:

    - There isn't a mailing list
    - There aren't developers teams, PHP-Nuke is the result of my needs and
      collaboration of some good people who know much PHP than me (I'm learning
      so much, you can expect a complete rewrite of entire system in the future)
    - No, I'm not participating nor reading SourceForge forums
    - This (3.5) is the last release in SourceForge, next releases will be only
      available on the official site (http://www.ncc.org.ve/php-nuke.php3)
    - Thanks for understand the above issues!


*****************************************************
* PHP-Nuke URL: http://www.ncc.org.ve/php-nuke.php3 *
*****************************************************

Enjoy!

-- Francisco Burzi
1	dpavlin	1.1	PHP-Nuke: Web Portal System
2			===========================
3
4			Base Requirements
5			-----------------
6
7			In order to setup Nuke the folowing prerequisits are necessary.
8
9			A Linux Box (http://www.linux.org) Installed and working properly.
10			Apache Web Server (http://www.apache.org)
11			PHP (mod_php) Apache module (http://www.php.net)
12			MySQL database server (http://www.mysql.com)
13
14			The above doesn't mean it work with other configurations, OS's, DB's etc,
15			but we only provide INSTALL instructions for the above configuration.
16
17			Set-up of these required packages is beyond the scope of this document
18			and if you are unsure you should check with each of the appropriate web
19			sites for further details.
20
21			At this moment is known that PHP-Nuke has some problems working with PHP4,
22			when I have some money to buy a test machine to install in my LAN I promise
23			that I'll look into this to make it 100% compatible with PHP 3 and 4.
24
25
26			Installing the Package
27			----------------------
28
29			Unzip and Untar the package into the directory you want to use on you web
30			server, if you're unsure where that is, ask you system administrator.
31
32			tar -zxvf PHP-Nuke.tar.gz
33
34			Change to the sql/ directory and there is a file called "nuke.sql"
35			this file contains the commands to build the database structure,
36			tables and the default data.
37
38			1) Create a database called, for example, nuke:
39
40			mysqladmin create nuke
41
42			2) Now fill the databases with the tables in nuke.sql file:
43
44			mysql nuke < nuke.sql
45
46			3) That's it!... now you need to edit the file "config.php", read the comments
47			for each option, and make the changes necessary for your installation
48			when you have finished making your changes you are ready to launch your
49			web browser.
50
51			Upgrading from previous versions
52			--------------------------------
53
54			To upgrade a prevoius PHP-Nuke installation to this new version you
55			need to launch your web browser to:
56
57			http://www.yourdomain.com/upgrades/upgrade1-25.php
58
59			to upgrade from 1.0 and
60
61			http://www.yourdomain.com/upgrades/upgrade2-25.php
62
63			to upgrade from 2.0x
64
65			all the new tables will be added and updated automagically without touch
66			your old data, then you need to reconfigure the file config.php to match
67			your site's info.
68
69
70			Testing the Installation
71			------------------------
72
73			Go to your homepage, for example:
74
75			http://yourdonaim.com/index.php
76
77			To initiate your activities in your site, you need to login as Administrator at:
78
79			http://yourdomain.com/admin.php
80
81			at the login prompt enter the following:
82
83			AdminID: God
84			Password: Password
85
86			this will give you full administrator priviledges to your installation of Nuke.
87			For security reasons please remember to change the admin password and nickname
88			"immediately". You can do this by clicking on the "Edit Admins" option.
89			Remember to "Logout" from admin after you use it, from this area you can
90			delete or add content on your site, never leave your computer without logggin out
91			from the admin account. If something bad happens don't come crying to me.
92
93			I recommend the use of phpMyAdmin. It's a good administration system for
94			MySQL databases. To download it just go to http://phpwizard.net/phpMyAdmin
95
96			I also recommend to set a password for your MySQL access. This is important
97			as some data in the nuke database is not encrypted, so for security reasons you
98			need to set a password, not only that, it's good practice!
99
100			For Banners System, when you setup a new client, you need to assign a new
101			login/password for him. The login and password is used by the client at the url:
102
103			http://yourdomain.com/banners.php?op=login
104
105			in order to let the client view and track the banners stats in real time
106			just pass that url to your clients. Take a look yourself before you do.
107
108
109			Theme Customization
110			-------------------
111
112			If you want touse any other included theme as the default theme, just rename
113			the "Default" folder in themes directory to whatever you like, and then rename
114			any other theme directory to "Default". Also you need to add to the new theme
115			the section in html for the users login. This section is in header.php file.
116
117			That's it! You're done with PHP-Nuke. Just navigate around, play with it,
118			abuse it and if you like PHP-Nuke, use it. Spend some time getting used to the
119			administration interfaces.
120
121			To change your site's logo, go to the themes directory and make a custom
122			logo for each individual theme. Just navigate around all themes and change
123			the graphics you want.
124
125			A note for the PHP-Nuke site's administrators: Only admins (authors) can
126			view the following data in the site:
127
128			- Administration Menu
129			- Number of New Submissions
130			- Edit button for each link in Web Links
131			- Edit and Delete options for each Article
132			- Delete option for each comment
133			- IP/Host address of the comment poster
134			- Moderation option and button (if set for admin only through config.php)
135			- more in the future versions...
136
137			I made this software free, and released it under GPL, so this software
138			costs you exactly "nothing". All that I ask you is, if you use it "please"
139			try to leave a link from your pages to http://www.ncc.org.ve/php-nuke.php3
140			and let others know that you're using PHP-Nuke. That's all I ask. If you
141			want to make me a donation, please contact me by email at fburzi@ncc.org.ve
142			I'll appreciate any money, books or new/used hardware you want to donate to me. I promise to improve this
143			software and make more for web production.
144			If you want to donate something without mail me, just send your donation to:
145
146			Francisco Burzi C.
147			Av. Principal Pueblo Nuevo
148			Via Poligono de Tiro
149			Casa # Z-1315
150			San Cristobal, 5001
151			Estado Tachira
152			VENEZUELA
153
154			If you send me any Windows related stuff you will be burn in hell, for sure!
155			Send all you want for Linux, or anything that works in Linux.
156			Finally, if you use PHP-Nuke in your site, please let me know and I'll put
157			a link back to your site from mine in the PHP-Nuke page. Ok?
158
159			Enjoy this software!
160
161			PS: When you e-mail me asking something, just remember that I receive more
162			than 600 e-mails per day!!! so I can't answer to all you, but for sure
163			I'll read it. But please don't expect an answer if your mail is a question
164			about how to do this or that.
165
166			Due to a lot of emails I received I want to say:
167
168			- There isn't a mailing list
169			- There aren't developers teams, PHP-Nuke is the result of my needs and
170			collaboration of some good people who know much PHP than me (I'm learning
171			so much, you can expect a complete rewrite of entire system in the future)
172			- No, I'm not participating nor reading SourceForge forums
173			- This (3.5) is the last release in SourceForge, next releases will be only
174			available on the official site (http://www.ncc.org.ve/php-nuke.php3)
175			- Thanks for understand the above issues!
176
177
178			*****************************************************
179			* PHP-Nuke URL: http://www.ncc.org.ve/php-nuke.php3 *
180			*****************************************************
181
182			Enjoy!
183
184			-- Francisco Burzi