Overview
WebAsyst Collaboration Software Suite includes multiple web-based applications designed to help your team work collaboratively.
Depending on your task and the scale of your team, you can install WebAsyst on your personal desktop computer, on the server in your local or corporate network or on a web server connected to the Internet.
WebAsyst is a PHP-based open source and can be installed on any standard web server with PHP support, e.g. IIS (Windows) or Apache (Linux, FreeBSD,).
Once your have WebAsyst installed on your web server, users can easily access it using standard web browser (e.g. IE, Mozilla, FireFox) or our Windows desktop program - WebAsyst Windows Client.
Table Of Contents
Where to install?
You can install WebAsyst on the Linux and Windows platform and on a virtual or dedicated web server.
Linux/FreeBSD
You can install WebAsyst on a UNIX-based web server, e.g. Apache on Linux or FreeBSD platform.
To install WebAsyst, you must create a separate directory on your Apache server and setup HTTP access to this directory. The directory must be writable by the user that starts the server.
Windows
You can install WebAsyst on a Windows NT web server, e.g. IIS or Apache.
To install WebAsyst, you must create a separate folder on your server and setup HTTP access to this folder. If your file system is NTFS, then this folder must be writable by the user that starts the server.
Virtual Hosting
Virtual host providers usually allow limited amount of MySQL databases. To install WebAsyst, you must have at least one MySQL database on your server, which must be created before you start WebAsyst Installation procedure. To create MySQL database you should use the tools given by your host provider, e.g. PHP MyAdmin or CPanel.
It is recommended to install WebAsyst in a sub-directory on your virtual server, created in a directory which is accessible via HTTP, e.g. public_html/webasyst.
NOTE: The directory where you install WebAsyst must be writable by PHP user. Permission value for UNIX-based server is usually 775. Refer to your web server manual or contact your ISP for further details.
Dedicated Server
If you rent or own a dedicated web server, you probably have administrative permissions on this server. During the WebAsyst setup process you have to create at least one database (MySQL) on your server. Contact your web server admin to make sure you have rights to create database on your server.
To install WebAsyst you must create directory on your server which is accessible via HTTP and writable by PHP user.
NOTE: Once installation is complete you may disable access to all WebAsyst sub-directories except published directory, to protect your WebAsyst data from unauthorized access.
Table Of Contents
System Requirements
To install WebAsyst you must have a web server (either on your desktop computer, on the local network server or hosted by your ISP) with the following previously installed software:
NOTE: For up-to-date system requirements please refer to http://www.webasyst.net/requirements.htm
1. OS: Windows 2000/2003/XP/NT or Linux or FreeBSD 4.x
2. Web-server with PHP support, e.g. IIS or Apache
3. MySQL version 4.1.x, 5.0
4. PHP version 5.x with the following extensions:
- DOMXML (required). Used virtually everywhere in the system to parse and create XML documents. This extension is only available if PHP was configured with --with-dom[=DIR]. Add --with-dom-xslt[=DIR] to include DOM XSLT support. DIR is the libxslt install directory. Add --with-dom-exslt[=DIR] to include DOM EXSLT support, where DIR is the libexslt install directory.
Note to Win32 Users: In order to enable this module on a Windows environment, you must copy one additional file from the DLL folder of the PHP/Win32 binary package to the SYSTEM32 folder of your Windows machine (Ex: C:WINNTSYSTEM32 or C:WINDOWSSYSTEM32). For PHP <= 4.2.0 copy libxml2.dll, for PHP >= 4.3.0 copy iconv.dll from the DLL folder to your SYSTEM32 folder.
See also: http://www.php.net/manual/en/ref.domxml.php
- GD (optional). Provides functions to work with image files. Used to create and maintain thumbnails and all sort of graphics. To enable GD-support configure PHP --with-gd[=DIR], where DIR is the GD base install directory. In Windows, you'll include the GD2 DLL php_gd2.dll as an extension in php.ini. The GD1 DLL php_gd.dll was removed in PHP 4.3.2.
See also: http://www.php.net/manual/en/ref.zlib.php
- ZLIB (optional). Used to compress/uncompress ZIP archives. ZLIB support in PHP is not enabled by default. You will need to configure PHP --with-zlib[=DIR] The windows version of PHP has built in support for this extension. You do not need to load any additional extension in order to use these functions.
See also: http://www.php.net/manual/en/ref.image.php
To run installation script (install.php - included in your package), as well as to work with WebAsyst, you must have a computer connected to your web server with one of the following browsers:
Windows 2000/2003/XP/NT:
- Internet Explorer 5.5
- Firefox/0.10
- Mozilla 1.5
- Netscape 6.0
Mac OS X (v 10.2):
- FireFox v 1.0
- Safari 1.0 (v. 85.5)
Red Hat 9:
- Mozilla 1.4
NOTE: Java-script and cookies must be enabled in your browser.
Table Of Contents
Installation Procedure
WebAsyst installation package is usually delivered as a TGZ or ZIP archive file which you can download from your account in the WebAsyst Customer Center.
Once you have installation archive downloaded, uncompress its entire content into the folder on your web server where you wish to install WebAsyst.
Sample:
If you have Linux server, simply run the following command:
tar -zxvf webasyst_setup.tar.gz
With Linux you may also use Midnight Commander. Just open webasyst_setup.tar.gz file and copy all its content into installation directory.
If you use Windows-based server, then you may use WinRar (version 3 or higher). Again, just open the archive you have downloaded and copy its content into installation directory.
NOTE: Do not extract files from sub-archives included in the installation package. The install.php script will do it for you.
Table Of Contents
Configuring your PHP server
To install WebAsyst you must disable SAFE_MODE option in PHP.INI file on your server:
safe_mode = off
To run WebAsyst, you must have set the following parameters in PHP.INI file on your server:
session.use_trans_sid = off
session.auto_start = off
session.use_cookies = 1
session.use_only_cookies = 1
allow_call_time_pass_reference = 1
magic_quotes_gpc = 1
magic_quotes_runtime = 0
session.name = SID
display_errors = 0
output_buffering = On
auto_prepend_file =
If it is not possible to modify PHP.INI file (e.g. most of virtual hosts do not allow this) then you may override these settings by use of .htaccess file, which must be located in the directory where you have installed WebAsyst.
php_flag session.use_trans_sid off
php_flag session.auto_start off
php_flag session.use_cookies 1
php_flag session.use_only_cookies 1
php_flag allow_call_time_pass_reference 1
php_flag magic_quotes_gpc 1
php_flag magic_quotes_runtime 0
php_value session.name SID
php_flag display_errors 0
php_flag output_buffering On
php_value auto_prepend_file none
NOTE: For .htaccess file to be applied you must have following
directive set in your Apache configuration file - httpd.conf
AllowOverride All
Table Of Contents
Running INSTALL.PHP
To start installation, point your browser to the folder on your web-server where you have placed the content of WebAsyst installation archive and run install.php script.
NOTE: WebAsyst installation folder must be located on the web server (e.g. Apache or ISS). Dont mix it with regular local folder. Refer to your web server documentation. URL to this folder may look like in a sample below (provided webasyst folder is located in the root directory on your web server):
http://localhost/webasyst/install.php
Once you start running install.php script, it is checking if your server satisfies to the system requirements.
NOTE: Refer to http://www.webasyst.net/requirements.htm for up-to-date information about system requirements.
Table Of Contents
Searching for installed components
Once system requirements verification has been successfully passed, install.php script looks for previously installed WebAsyst components (files and sub-directories) in your installation directory.
If you install WebAsyst into a new empty directory, then the installation script will extract all files into this directory and lead you to the following steps to setup MySQL Server and create administrative and working databases.
If you run install.php script in the directory where you have previously installed WebAsyst, then the installation script will offer to upgrade your WebAsyst.
NOTE: Please refer to the Upgrade Procedure section below to learn more about WebAsyst Upgrade.
Table Of Contents
Extracting files
WebAsyst Installation package includes wbs.tgz archive file. Install.php script extracts all files and subdirectories from wbs.tgz archive and copies them into the directory where you install WebAsyst.
NOTE: The directory where you install WebAsyst must be writable by PHP user. Permission value for UNIX-based server is usually 775. Refer to your web server manual or contact your ISP for further details.
Once you have successfully extracted files into installation directory, you must proceed to the following steps to complete installation:
-
-
Table Of Contents
Setting up MySQL Server
You can use WebAsyst with multiple MySQL Servers installed on your web server. On each MySQL Server you can install as many WebAsyst working databases as you need.
The benefit of using multiple MySQL Servers: For each server you may customize language settings to provide multi-lingual support for your WebAsyst content.
WebAsyst Installation Wizard allows you to create your first MySQL Server. Once you complete installation you can customize parameters which you specify during this installation procedure and add new MySQL Servers as you need.
Following is a list of MySQL Server parameters you must specify during the installation process:
| Parameter |
Description |
| Server Name |
Create a name for MySQL server for further reference (e.g. MyServer).
NOTE: Server Name can not be modified later. |
| MySQL Host |
IP-address or name of the computer where MySQL server is installed. If MySQL server resides on the same computer as WebAsyst scripts then leave default value in this field: localhost. |
| WebAsyst Host |
IP-address or name of the computer where WebAsyst scripts are installed as it is visible from MySQL server. If MySQL server resides on the same computer as WebAsyst scripts then leave default value in this field: localhost. |
Port
|
TCP/IP port number for MySQL server. If the port number is not given, the default value 3306 is used.
|
| My SQL User Name & Password |
Name and password of MySQL User as given by your MySQL Server administrator. If this user has administrative privileges on the server, you should choose I am MySQL Administrator option below. Otherwise you must use I have NO administrative rights on this MySQL Server option, which does not allow you to create new databases on the server. |
Table Of Contents
Creating Working Database
With WebAsyst you can create as many working databases as you need. For a working database you can either use new or existing MySQL database. If you want to use existing database, we strongly recommend using empty database which does not contain previously created tables or other objects.
WebAsyst Installation Wizard allows you to create your first working database. Once you complete installation you can customize certain parameters which you specify during this installation procedure:
| Parameter |
Description |
| Database Server |
The name of MySQL Server created on the previous step of the installation process is substituted. |
| Create new database |
Use this option if you have rights to create database on the selected server. If you use this option you must create unique name for your new database and enter this name into the Database Name field. This name can not be modified later. |
Use existing database |
Use this option if you want to install WebAsyst into existing empty database.
NOTE: This is usual option for virtual hosting where you can create database only by use of stand-alone tools given by ISP, e.g. PHP MyAdmin or CPanel.
|
| Database Name |
If you have chosen "Create new database" option then create a unique name for your new database. Otherwise, enter the name of existing database. |
| Database Key |
Enter optional unique nickname (alias) to identify your database (e.g. MyWebAsyst or MyDatabase). Create Database Key which you can easily remember. This database key will be used in your login URL and on your WebAsyst Login page.
NOTE: If you leave this field blank Database Key will be automatically generated from the Database Name (first 16 characters will be used). Once created Database Key can not be modified later
|
| Company |
Used as a title for your database. Could be a name of the company who owns this database or your nickname. |
| First Name |
First name of the first user who will be able to login this database. This user will be added in the User List of this database. |
| Last Name |
Last name of the first user who will be able to login this database. This user will be added in the User List of this database. |
| Email: |
Enter Email address of the first user whose name has been entered above.
NOTE: Specify valid email in this field to receive login instructions. Used also as an email for administrative login can be modified later.
|
| Login Name & Password |
Create a login name and password for the first user to login this database. |
Table Of Contents
Login to your Working Database
Once you have successfully completed setup process as described above and created your first working database, you can login to WebAsyst.
At the final page of the WebAsyst Installation Wizard you can see a login URL to your working database like in a sample below:
http://[DOMAIN][/WEBASYST]/published/login.php
Here [DOMAIN] is domain name or IP address of the server, and [/WEBASYST] is optional path to the directory where you have installed WebAsyst.
To login your working database for the first time you must use the Username and Password which you have specified on the Creating Working Database step of this installation procedure.
NOTE: You can also login your working database as Administrator. The primary purpose of Administrator is to create accounts for other users and customize their access rights. Please do not confuse Administrator account with WebAsyst Administrator tools described below.
Table Of Contents
Administrating Your System
WebAsyst Administrator is a major tool which you can use to:
- Customize common WebAsyst settings
- Add and modify MySQL Servers
- Add and modify working database(s)
- Localize (translate) WebAsyst to other languages
- Tune SMS gateways to allow sending SMS messages from WebAsyst applications
At the final page of the WebAsyst Installation Wizard you can see a login URL to your WebAsyst Administrator like in a sample below:
http://[DOMAIN][/WEBASYST]/published/admin.php
Here [DOMAIN] is domain name or IP address of the server, and [/WEBASYST] is optional path to the directory where you have installed WebAsyst.
Table Of Contents
Security Issues
In the WebAsyst directory hierarchy you need only the published directory to be opened for HTTP access. Following directories data and dblist - contain critical user data and should be closed for direct access.
If you have no administrative privileges on your Apache web server where you have installed WebAsyst, you can place .htaccess files in the directories mentioned above and add configuration entries in these files which expressly prohibit HTTP access.
If you have IIS web server, your may customize permissions to the data and dblist directories by setting proper values for access options, e.g. Read, Directory Browsing etc.
Table Of Contents
Upgrade Procedure
To upgrade WebAsyst you must run installation script in the same directory where you have installed previous version:
- Download most recent installation archive file (TGZ or ZIP) from your account in the WebAsyst Customer Center.
- Uncompress entire content of the archive file into the folder on your web server where you have previous version of the WebAsyst installed. Replace old files with new ones.
- Run install.php script.
Installation script compares the new version of WebAsyst being installed (version info stored in update.xml file) with the current version of WebAsyst which has been previously installed (stored in wbs.xml file).
If version numbers are the same in both files, then you can still run installation script to repair WebAsyst. If new version number is greater than current one, then installation script will upgrade your WebAsyst to the new version. Installation script may update your WebAsyst database(s) structure, if metadata changes occurred in the new version.
NOTE: If new version number is smaller then current version number then installation script quits.
Table Of Contents
Repair previous installation
You may run the same version of installation script in the directory where you have previously installed WebAsyst. It might be useful if you want to repair your current WebAsyst installation in case you have missing or corrupted files.
Table Of Contents
Minor updates (no database modifications)
WebAsyst upgrade may contain only PHP scripts (or other files, e.g. localization strings or configuration XML files) modifications. In this case installation script will just replace current files with new ones. No database structure modifications will be applied because no metadata changes occurred in the new version.
Table Of Contents
Updates with database modifications
WebAsyst upgrade may require database structure (metadata) modifications. Metadata modification script is stored in update.xml file (included in the installation package) and contains modification code for all WebAsyst versions.
If you upgrade WebAsyst from version X to version X + N then N pieces of metadata modification code will be applied to all working databases on your WebAsyst Server.
Table Of Contents
It is recommended deleting files that become obsolete in a newly installed version. These files are stored in kernel/includes/smarty/compiled, in the directory where WebAsyst is installed. Presence of files from older version(s) in the above mentioned folder may cause some distortions in displaying WebAsyst pages in a newly installed version.
Table Of Contents
WebAsyst Windows Client
WebAsyst Windows Client program is an alternative way (in contrast to web-browser client) to access WebAsyst Server from your desktop computer. WebAsyst Windows Client features standard GUI interface, uses SOAP+XML to communicate to WebAsyst Server and provides faster access than HTML (web browser) client.
You can download WebAsyst Windows Client setup program from the following address:
http://www.webasyst.net/downloads.php
Once you have downloaded WebAsyst Windows Client setup program, just run it and follow standard Windows-style installation wizard.
After you have successfully installed WebAsyst Windows Client on your desktop computer you must setup connection to the WebAsyst Server. To do so:
- Run WebAsyst Windows Client.
- Click Host Setup button in the Login form.
- Click New button in the WebAsyst Host List form.
- In the Host name field in WebAsyst Host Settings form enter a reference name for the computer in your network or in the Internet where you have WebAsyst Server installed, e.g. My WebAsyst Server. This name will appear in the Host menu in Login form.
- In the Host address field of the WebAsyst Host Settings form, enter URL of the computer in your network or the Internet address where you have WebAsyst Server installed, e.g. http://yourdomainname.com/webasyst
Table Of Contents
|