community.egroupware.org: Community wiki

  
Community wiki
QuickInstallGuide

This article is just a kind of 'Quick Install' for the complete Installation Guide go to ManualSetup.

If you are using any eGroupWare release previous to 1.2, please upgrade to 1.2 first, then come back here and follow this article.

Download egroupware 1.4

In this release, there have been changes in the packages. There is only one central package, containing only the core and supported apps that have been proved to work with the new API functions in 1.4, and there are no contrib packages anymore because lack of maintenance by the authors, regardless lack of integration with the API. There are two main exceptions, jinn and workflow, which have a different release cycle, so you have to check them out from trunk if you want to use/keep using them. The other exception is tts, that has been replaced with a new application called tracker.
Apart from the core package, there are three separate packages: egw-pear, gallery and icalsrv. They are optional, but take egw-pear as if it was mandatory, because it includes some functions necessary for some basic operations. So, make sure you get both the core and egw-pear from the download page at sourceforge.net.
Other basic requirements are php 5 (you can find problems using php 4, so please try to upgrade first) and the pear package from http://pear.php.net (though there's a php-pear package in most linux distributions that should work).

The rest of the steps are very similar to the standard upgrade process for previous versions, but there are some minimal changes.

Uncompress downloaded files

If you want, you can perform a backup of the current tree for some apps that might use part of the tree to store some data (in particular, the header.inc.php file, where the initial configuration is saved). Then, you can uncompress the downloaded files, overwriting the existing tree. Make sure that the webserver can write in the root tree.

Setup eGroupWare

From time to time, you may have to access egroupware setup for some taks, like a first time installation or update. This is done by accessing the setup directory using the browser, that you will see in the same tree when you uncompressed the files. So, taking that the url for the tree where the files are uncompressed is http://mydomain.com/, the url you should type in your browser is http://mydomain.com/setup/. Hint: if you plan to have a public site at http://mydomain.com (i.e, the login form shouldn't be seen), then set your tree to something like http://mydomain.com/egroupware/, and later build a site with site manager. Whatever method you choose for the url of your site, the shortcut is to use "/setup" for referring to the setup application. Once in /setup, the installation process will check if a new installation or an upgrade is taking place.

New installation

  • Choose the language of your choice for the setup process
  • In the "Check installation" screen, make sure you have support for your db type (or ldap) in php, and fix problems and warnings. This is only a check page to try to cover all possibilities for installing egroupware. Override only if you know what you're doing, that is, you don't get errors or warnings on the specific components that your installation relies on. In case of doubt, go on. You can come back here at any time later to check if support for an specific component is enabled. You may find pear issues here, so reread the beginning of the article about pear requirements.
  • Next screen is "Header / Admin" configuration, where you manage the setup process and create the header.inc.php file (where the settings are stored).
    • First, set the user and password for "Header / Admin" (where you're right now, in order to be able to come back later).
    • Make sure you don't restrict your ip in the textbox below for accessing the setup process (you can leave the textbox blank).
    • Define the session and encryption type (you can leave the defaults in case of doubt). The one with the best performance is "PHP plus restore", so try to use this. If you find later session problems, try first  checking how your php installation stores sessions, and if you still can't log in successfully, try changing this value and log in again, but it should be possible to use this option.
    • For every domain:
      • Define the domain name. The default is 'default', which is safe, but it can be necessary to change if you want authentication against a mail server or something using a DNS domain name.
      • Make sure your php installation has the proper driver for your db. At the top of the screen you'll find some diagnostics. If you need to install some missing driver, just refresh this screen after installing it and restarting the webserver.
      • It's better you create the db and user manually at this point if they're not created, to avoid further problems. If you're a newbie and don't know what to do, the most usual situation is running mysql and apache in the same host, and the default installation of mysql should allow you to do these commands, that will create a user in mysql called 'egwuser' in 'localhost', which access to a db called 'egroupware' and with a password 'egwpass' (opening a console as root):
        • # mysql
        • mysql> CREATE DATABASE egroupware;
        • mysql> GRANT ALL ON egroupware.* TO 'egwuser'@'localhost' IDENTIFIED BY 'egwpass';
        • mysql> FLUSH PRIVILEGES;
        • mysql> exit
        • #
      • Set the db type together with the connection data (user, host, password).
      • Set the user and password to access every domain settings. You'll find the setup access right after submitting the form, when you've finished setting all the values. When you get there, you'll have to use the user and password set here for every domain you want to setup, so you decide at this point the security for that access.
    • You can add other domains here, so repeat the above steps for every domain you create.
    • Click on the 'Save' button and continue to 'Setup / Config'. You should see a message indicating that the header.inc.php file was created. If not, make sure (once more) that the webserver has write access to the egw root directory.
  • You should be now in the main setup form. Enter the user and password you have just specified in "Header / Admin" for setup process for your domain, choose the language of your choice and click the 'Login' button to enter in the configuration.
  • If you didn't create the db (or the connection settings you specified don't work for any reason), you are prompted here to create the db with a special user, but this might work or not depending on your db. Choose the method you prefer in order to make match the db settings with a working db for egroupware before going next step. Maybe you have to go back to "Header / Admin" first and change some of the db settings.
  • You'll be prompted to install all apps, so click the button and let the setup process do the installation automatically for you. Once it's over, you'll be offered a 'Check my installation' button before enabling the next steps. Click it and see the messages (there should be none). The next steps will become available.

Upgrade from 1.2

  • You might be asked to upgrade the header.inc.php file, in whose case, you'll be taken to "Header / Admin". Just save the file (after making some change, if you want) and then, clicking the 'Continue' button for the main installation menu.
  • Enter "Setup / Config", where you'll be prompted to upgrade. Make sure the "Backup your data now" checkbox is checked, and click "Upgrade now". It may take some minutes.
  • When the update is finished, click the 'Check my installation' button to enable the rest of steps.
  • You may find that some apps haven't been upgraded because of dependencies. In this case, you should enter in step 5 and check dependencies. The main known reason is that egw-pear didn't exist in 1.2 and in this release some apps depend on egw-pear, so install egw-pear first and come back when it's installed. Then, check the pending apps and repeat the process until all existing apps are installed. Reread the text above about supplied apps in this release if you miss some app that you expected to find. You can try to make work old unsupported apps, but it's totally up to you.

The next steps are common for both cases.

  • Enter into step 2 by clicking 'Edit current configuration'. There are some critical fields.
    • In 'Path info':
      • For all paths, we'll take as base directory '/var/lib/egroupware/<domain>/', replacing "<domain>" with your egw domain name.
      • For the directory where your users' data will be stored (unless you use WebDAV, in whose case you should enter the url), append "files" to the base directory, so the result is '/var/lib/egroupware/<domain>/files' (it should appear by default). Make sure the directory exists and that is writable by the webserver.
      • For the directory for backup files, it should be a directory named backup following the same process.
      • The base URL for accessing eGroupWare. The setup process detects by default the current url, so don't change it unless you know what you're doing.
    • Server info:
      • In the hostname field, leave the setting unless you know what you're doing.
    • Mail server settings:
      • Set the incoming mail server host and type, together with the domain name (what is after the '@' in the email address). If you don't know what to put here, try 'localhost', to at least override warnings.
      • Set the outgoing mail server (SMTP) settings. The default port for smtp servers is 25.
    • Authentication / Accounts:
      • Authentication type: there are many types of authentication supported in egroupware. The authentication means where egroupware will search for users and passwords, being the default a SQL database, but there are other types supported. In any case, you'll have to fill the required data in the fields below corresponding to your settings. Usually, you'll use 'SQL' for authentication. If you intend to use LDAP for authentication, you only have to enter the LDAP server, together with the base dn to search accounts in the "if you use LDAP" section below.
      • Storage: this is the next field, and is where the account identifiers (soapps can know owners and who can access info) will be stored. Possible values are SQL and LDAP.
        • SQL: This is the default to store account data, together with 'MD5' encryption type for passwords. NOTE: if you change the encryption with existing accounts, those accounts won't be able to login again, unless an admin manually sets the password in user accounts in admin app. In a new installation, you should safely try 'MD5_CRYPT' instead.
        • LDAP: If you intend to save account data (create or delete accounts, change password, etc), then you need to have write access to the LDAP tree, so besides the server and accounts context, supply the dn for an account with write privileges in the LDAP tree with its password, and the group context (for managing groups). There have been critical changes in the way LDAP works, so you should take a look at the info in phpgwapi/doc/ldap/.
    • The rest are not required, but the defaults don't throw errors. You can come back here at any time later to change any setting. Click 'Save'.
  • In a new installation, go to step 3 by clicking the 'Create admin account' button, and enter the admin data. It's not recommended to create additional users here, but from the admin interface later.
  • Install the languages you want in step 4 by clicking the 'Manage languages' button. Select the languages you want to install (hold the Ctrl key while clicking any language you want to add or remove) and click 'Install'. When finished, click 'Cancel' to go back to the previous screen.
  • Check the status of the apps in step 5 by clicking the 'Manage applications' button. Check that all apps are properly installed. There might be some apps in an upgrade process that didn't install or upgrade completely, so check the upgrade (and even the install) column for those apps that are not properly installed, and click 'Save'. Repeat this for all apps you want installed. When finished, click 'Cancel' to go back to the previous screen.

At this point, everything should be fine. Click 'Go back to user login' to start using eGroupWare. Enjoy!

This article was written by Oscar Manuel Gómez Senovilla 2007 as an Knowledgebase article and migrated to this wiki later by Frank-D.



You are here