"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "README-PHAR.TXT" between
cmsms-2.2.15-install.zip and cmsms-2.2.16-install.zip

About: CMS Made Simple is an "easy-to-use" content management system for simple, stable content sites.

README-PHAR.TXT  (cmsms-2.2.15-install)	:	README-PHAR.TXT  (cmsms-2.2.16-install)
--------------------------------------------------		--------------------------------------------------
CMS Made Simple PHAR Based Installation Assistant		CMS Made Simple PHAR Based Installation Assistant
--------------------------------------------------		--------------------------------------------------
This document describes using the CMS Made Simple PHAR Based installation assist ant.		This document describes using the CMS Made Simple PHAR Based installation assist ant.
The PHAR based installation assistant is an entire PHP application built to prov		The PHAR based installation assistant is a stand-alone PHP application built to
ide the ability to		provide
install, upgrade, or freshen CMS Made Simple from within a single, easy to use p		the ability to install, upgrade, or freshen CMS Made Simple from within a single
hp script.		easy-to-use PHP script.
		-------------------
NOTE:		NOTE:
		-------------------
The PHAR based installation assistant is a binary file and must be transferred i n binary mode!		The PHAR based installation assistant is a binary file and must be transferred i n binary mode!
		-------------------
Requirements		Requirements
1. The installation assistant requires a PHP environment with a minimum version		-------------------
of PHP 5.4.0 with the Phar library enabled.		1. The installation assistant requires a PHP environment with a minimum version
2. For new installations of CMS Made Simple you should create a new mysql datab		of PHP 7.1.
ase and database user.		2. The website's PHP environment must include the PHAR extension.
		3. For new installations of CMS Made Simple you should create a new mysql datab
		ase and database user.
- The database user must have ALL PRIVILEGES to all tables within the new da tabase.		- The database user must have ALL PRIVILEGES to all tables within the new da tabase.
- Your database user account must have a password.		- Your database user account must have a password.
3. CMS Made Simple itself requires at least PHP 5.6 with numerous libraries ena		4. CMS Made Simple itself requires at least PHP 7.1 with numerous libraries ena
bled (the install assistant will check for these) including json, tokenizer, xml		bled
, and gd.		(the install assistant will check for these) including json, tokenizer, xml,
4. Your PHP environment must include the PHAR extension		and gd.
		-------------------
Instructions		Instructions
1. Upload the cmsms-<version>-install.zip file to your web directory.		-------------------
2. Extract the files from the .zip file		1. Upload the cmsms-<version>-install.php file to your website top directory.
This will create a cmsms-<version>-install.php file, and another copy of thi		2. In your web browser, navigate to <your web directory>/cmsms-<version>-instal
s README file.		l.php
3. Using your browser, navigate to <your web directory>/cmsms-<version>-install		For example: http://www.mywebsite.site/cmsms-3.44.55-install.php
.php
For Example: http://www.mywebsite.site/cmsms-2.0-install.php
You should now be presented with a welcome screen. If, instead, you see a white screen it probably means that your		You should now be presented with a welcome screen. If, instead, you see a white screen it probably means that your
server is running old, or incompatible software and that you may be forced to us e the traditional installer. It is a good		server is running old, or incompatible, software and that you may be forced to u se the traditional installer. It is a good
hint that if the Phar installer will not run you may have further problems with CMS Made Simple on that server.		hint that if the Phar installer will not run you may have further problems with CMS Made Simple on that server.
The installation assistant can then be used to guide you through the process of installing a new version of CMSMS,		The installation assistant can then be used to guide you through the process of installing a new version of CMSMS,
Upgrading an existing installation of CMSMS, or freshening an existing version o f CMSMS. There are various options		Upgrading an existing installation of CMSMS, or freshening an existing version o f CMSMS. There are various options
for each path through the installation assistant and 9 steps		for each path through the installation assistant and 9 steps
Step 1:		Step 1:
Step 1 asks you to select a language and optionally allows you to enable "Adva		The first step asks you to select a language and optionally allows you to enab
nced Mode". Advanced mode enables various		le "Advanced Mode". Advanced Mode
additional options throughout the assistant and increases the verbosity of the		enables several additional options throughout the assistant and increases the
status output.		verbosity of status output.
Step 2:		Step 2:
The second step does checks for existing software in your installation directo ry. If an existing installation of		The second step does checks for existing software in your installation directo ry. If an existing installation of
CMS Made Simple is detected you will be presented with options to proceed thro ugh the "upgrade" or "freshen" paths		CMS Made Simple is detected you will be presented with options to proceed thro ugh the "upgrade" or "freshen" paths
(depending upon the version detected). If no version of CMS Made Simple is ins talled you will be guided through the		(depending upon the version detected). If no version of CMS Made Simple is ins talled you will be guided through the
"installation" process.		"installation" process.
Step 3:		Step 3:
Step 3 performs various tests on your PHP environment to try to ensure that th		Step 3 performs various tests on your PHP environment to try to ensure that it
e PHP environment is compatible with		is compatible with
CMS Made Simple. If important tests fail you will be notified of them and not		CMS Made Simple. If important tests fail, you will be notified of them and not
allowed to continue. However, if		allowed to continue. However, if
some non critical tests fail you will be allowed to continue. We recommend tha		some non-critical tests fail you will be allowed to continue. We recommend tha
t you adjust your PHP environment		t you adjust your PHP environment
(you may need to contact your host for assistance) until all tests pass.		(you may need to contact your host for assistance) until all tests pass.
Step 4:		Step 4:
This step is used only during the installation or freshen paths. It asks you t o provide basic configuration information		This step is used only during installation and freshen sessions. It asks you t o provide basic configuration information
for the CMS Made Simple environment. This includes database information and cr edentials, and a server time zone.		for the CMS Made Simple environment. This includes database information and cr edentials, and a server time zone.
As mentioned in the requirements above. CMSMS requires a mysql database to sto		As mentioned in the requirements above, CMSMS requires a mysql database to sto
re data, and user credentials to access		re data, and user credentials to access
it. The user account provided must have ALL PRIVILEGES to the database. You		that mysql database. The user account provided must have ALL PRIVILEGES to the
can normally create		database. You can normally create
databases, and create user accounts for database from within your web host's c ontrol panel.		databases, and create user accounts for database from within your web host's c ontrol panel.
Additionally, you are asked to specify the time zone of the server (not your l ocal time zone). You may need to ask your		Additionally, you are asked to specify the time zone of the server (not your l ocal time zone). You may need to ask your
host for information about this.		host for information about this.
Upon submit, the installation assistant will validate your database credential s, and check the database to ensure		Upon submit, the installation assistant will validate your database credential s, and check the database to ensure
you are not accidentally overwriting an existing installation of CMSMS.		you are not accidentally overwriting an existing installation of CMSMS.
Step 5:		Step 5:
This step is used only during the installation path. It asks you to provide b		This step is used only during an installation session. It asks you to provide
asic credentials to the first Admin user		basic credentials of the first admin user
account. This Admin user account allows you to login to the CMSMS Admin consol		account. This admin user account allows you to log in to the CMSMS admin conso
e with all privileges and access to all		le with all privileges and access to all
of its functionality. From within the CMSMS Admin console you can create user		of its functionality. From within the CMSMS admin console you can create user
groups, and further user accounts		groups, and further user accounts
for additional site managers or editors.		for additional site managers or editors.
Unless you have enabled "Advanced mode" in step 1, you must also provide an em		Unless you have enabled "advanced mode" in step 1, you must also provide an em
ail address. The email address will be		ail address. The email address will be
used to send you your login credentials in the event of a lost or forgotten pa		used to send you your login credentials in the event of a lost or forgotten pa
ssword. An email will also be sent to you		ssword.
with your initial login credentials.
Step 6:		Step 6:
This step asks you for a human readable name for your website, and allows you to select additional language packs to install.		This step asks you for a human readable name for your website, and allows you to select additional language packs to install.
Additional language packs allow users who login to the CMSMS Admin console to		Additional language packs allow users who login to the CMSMS admin console to
display the output in their native language.		display the output in their native language.
Please note: though there are multiple languages available, not all of them ar		Please note: although there are multiple languages available, not all of them
e complete...		are complete.
Step 7:		Step 7:
This step copies all of the CMSMS core files from within the installation assi		This step copies all of the CMSMS core files from within the installation assi
stant into your CMS Made Simple install. It also		stant into your CMS Made Simple install.
cleans up those files.		It also cleans up those files.
Step 8:		Step 8:
This step interacts with the database to ensure that all tables and initial co ntent are created properly.		This step interacts with the database to ensure that all tables and initial co ntent are created properly.
During the installation process numerous tables and indexes are created in the		During the installation process numerous tables and indexes are created in the
database, and necessary initial data is installed.		database, and necessary initial data are installed.
Additionally (by default) sample data is installed. The sample data provides		Additionally (if so selected) sample site-content is installed. That provides
useful instructions on how to interact with,		useful instruction on how to interact with,
and build sites with, CMS Made Simple. It is recommended reading.		and build sites with, CMS Made Simple. It is recommended reading.
During the upgrade process, any necessary database changes are preformed to en sure that the database tables, and their contents,		During an upgrade session, any necessary database changes are performed to ens ure that the database tables, and their contents,
are compatible with the new version of CMSMS.		are compatible with the new version of CMSMS.
Step 9:		Step 9:
This step finishes the installation and performs a clean-up.		This step finishes the installation and performs a clean-up.
During the installation process all core modules are installed, necessary temp orary directories created, and the configuration file		During the installation process all core modules and selected non-core modules (if any) are installed, necessary temporary directories created, and the config uration file
is written.		is written.
During the upgrade process core modules are upgraded if necessary, and a new v ersion of the configuration file is written.		During the upgrade process core modules and selected non-core modules (if any) are upgraded if necessary, and a new version of the configuration file is writt en.
Any existing configuration file is backed up for safety. Additionally, the CM SMS cache is cleared.		Any existing configuration file is backed up for safety. Additionally, the CM SMS cache is cleared.
Once everything is complete you will be presented with links to either visit y our CMSMS website, or to login to its Admin console.		After everything is complete you will be presented with links to either visit the CMSMS website, or to log in to its admin console.
		-----------
Afterwards		Afterwards
After successful completion of the installation assistant, you should delete the		-----------
installation assistant .php file.
It is important for security purposes that you delete the installation assistant
.php file and this text file from your server after verifying that the operatio
n has succeeded.
		After confirming that the site is working as expected, confirm that the installe
		r .php file and related folder (with all its contents)
		have been deleted from the server. If not so, delete them manually, using the si
		te's file manager (in cPanel or the like).
		Likewise for any intaller.ini file, in the site-root folder, that was used to fa
		cilitate the installer session.
		---------------------
Additional Features		Additional Features
		---------------------
The single installation assistant package provides these features:		The single installation assistant package provides these features:
1. Installing a new version of CMSMS into an empty directory.		1. Installing a new version of CMSMS into an empty directory.
2. Upgrading an existing version of CMSMS to a new version		2. Upgrading an existing version of CMSMS to a new version
3. Freshening (or Repairing) an existing installation of CMSMS		3. Freshening (or repairing) an existing installation of CMSMS
This option may be useful for fixing a corrupted installation of CMSMS. Onl y available when the current version of CMSMS and the new version are identical, it will replace all of the core files with those distributed by the system and re-generate a new config.php file.		This option may be useful for fixing a corrupted installation of CMSMS. Onl y available when the current version of CMSMS and the new version are identical, it will replace all of the core files with those distributed by the system and re-generate a new config.php file.
4. Installing additional language packages		4. Installing additional language packages
As part of the "Freshen" functionality, when repairing an installation you h ave the option to install additional language packs.		As part of the "Freshen" functionality, when repairing an installation you h ave the option to install additional language packs.
5. Advanced vs. Simple mode		5. Advanced vs. Simple mode
---------------------------		---------------------------
Available Options		Parameter Details
---------------------------		---------------------------
The installation assistant supports the following URL based options:
1. TMPDIR=/absolute/path		1. tmpdir=/absolute/path
Specify the absolute path to the directory to be used for temporary files. This directory must be writable by the PHP process. This option should not be n eeded on most hosts.		Specify the absolute path to the directory to be used for temporary files. This directory must be writable by the PHP process. This option should not be n eeded on most hosts.
2. debug=1		2. debug=true
Attempt Turn on error reporting, and to display some meaningful help informa		Attempt turn on error reporting, and to display some meaningful help informa
tion.		tion.
3. nobase=1		3. nobase=true
Do not output a base href tag in the generated HTML.		Do not output a base href tag in the generated HTML.
4. dest=/absolute/path		4. dest=/absolute/path
Allow specifying a custom destination directory (must be an absolute path).		Allow specifying a custom destination directory (must be an absolute path).
5. nofiles=1		5. nofiles=true
Do not overwrite files. This is useful when needing to setup the database w hen the files have been manually extracted from the source code repository.		Do not overwrite files. This is useful when needing to setup the database w hen the files have been manually extracted from the source code repository.
6. clear=1		6. clear=true
Usable only on the first step, this will ensure that all preset config infor mation is cleared from the session (for development purposes only).		Usable only on the first step, this will ensure that all preset config infor mation is cleared from the session (for development purposes only).
---------------------------		---------------------------
Frequently Asked Questions		Frequently Asked Questions
---------------------------		---------------------------
Q: What is a PHAR?		Q: What is a PHAR?
A: A Phar is a single, self contained, executable PHP Archive. It allows us to distribute the CMSMS installation assistant as a single file even though it cont ains numerous libraries, classes, stylesheets, and scripts. This allows CMSMS us ers to install, upgrade or freshen their CMSMS systems by uploading a single fi le to their web server.		A: A Phar is a single, self contained, executable PHP Archive. It allows us to distribute the CMSMS installation assistant as a single file even though it cont ains numerous libraries, classes, stylesheets, and scripts. This allows CMSMS us ers to install, upgrade or freshen their CMSMS systems by uploading a single fi le to their web server.
Q: Why is there a .php file inside the archive, and not a .phar?		Q: Why is there a .php file inside the archive, and not a .phar?
A: Most web servers are not configured to treat files ending with .phar as execu table PHP scripts. Therefore we have renamed the file as a .php file so that we b servers will know to execute the script. Please note however, that this is a binary file and must be treated as such.		A: Most web servers are not configured to treat files ending with .phar as execu table PHP scripts. Therefore we have renamed the file as a .php file so that we b servers will know to execute the script. Please note however, that this is a binary file and must be treated as such.
End of changes. 32 change blocks.
76 lines changed or deleted		85 lines changed or added

---