workbase.

> quickstart

Quickstart - how to install or upgrade

A version of this document can be found in any workbase. package (it's the QUICKSTART.txt file)

1. Preparing the installation

If you are already running workbase., please skip to 1.1.

Before installation, you should make sure that you have a MySQL server, the username and password of which you know. On this MySQL server you should have a database created, to which the user has access to.

You will also need a FTP access to your webhost.

After downloading and unpacking your workbase. package to a location of your choice on your computer (we recommend using the free 7zip utility on windows), you will have a folder called workbase._[version number] in you hands. Later you will only have to upload the contents of it.

1.1 Preparations for upgrading

It is a good idea to back up your old config.inc.php file, in case you overwrite it during the upagrade process.

2. Installation

IMPORTANT: When uploading new files, make sure ALL old files are overwritten! If you see strange errors after upgrading, this is most likely the cause.

If you are already running workbase., please skip to 2.1.

To install, your first step is to upload everything in the package to a folder of your choice on the server.

After you have uploaded all of the files, you need to set the permissions of the config.inc.php file to 777 (readable, writable and executable by everyone). Afterwards, you can proceed and go to /install/ folder using your web browser. (for instance in http://www.yourdomain.com/workbase/install/)

To log in the installation tool, enter the standard password, which is "password" (without the quotes). Choose "New installation" as your option and click "next". Follow the instructions on the screen and complete the installation.

If you encounter problems, you can contact the support at support@dmonkeys.com, or try the help forums at the project page.

When sending a support request, please remember to include all error messages you received.

2.1 Upgrading

Upload the contents of "workbase._[version number]", excluding following folders and files:

  • /datatree/
  • /backup/
  • /pdf/
  • /entries.xml
  • /config.inc.php

Upload all other files and folders to the same location as your old installation, overwriting all existing files.

After this, you can enter the installation tool in /install/ and select upgrade as the installation option. If you see the text New configuration options available, it is a good idea to configure your installation first. (Actually, it's always a good idea to reconfigure your installation first.)

2.2 The installation tool

With the installation tool you can also recover lost superusers (in case the last superuser on the system has accidentally removed their own rights).

You can re-grant superuser privileges by going to the "reset admin" tab in installation tool and selecting one of the users who still have worker access to the system and granting them privileges.

You can also recover backups and change the installation tool password.

3. Post installation steps (IMPORTANT - Don't skip!)

After a successfull installation you should:

I Set read and write permissions for everyone (chmod 0777) on these files and folders:

  • /datatree/
  • /backup/
  • /pdf/
  • /entries.xml

II Verify that installation went as planned. Do this by entering the URL of workbase (e.g http://www.yourdomain.com/workbase/) and trying to log in. Before doing anything, however, complete the steps below!

III Delete the installation folder (or protect it by changing its password).

IV Start using workbase. :)

4. Installing additional languages

Since version 0.3.0, workbase. is distributed with the default language (english) only to quicken the release cycle.

You can download additional language packages as they come available for your version from http://workbase.sourceforge.net

After downloading an unpacking a language pack, all you have to do is to upload the unpacked folder to /lang/ and it will appear as a language option in user settings.