Installation

PageSeeder installation and upgrade instructions

New installation

For information regarding supported operating systems and hardware requirements, see Installing PageSeeder. Instructions for older versions of PageSeeder can be found at Installing version 5.6 or earlier.

Before beginning!

PageSeeder requires two important infrastructure components to function correctly – a relational database and an SMTP server to process email to function. To minimize the chance of installation-related problems, please closely read the following instructions.

First, consider the database

For a problem-free installation, please ensure the ability to communicate with MySQL before commencing the install. Do not wait for prompting from the install. By that point, 'problem-free'is no longer an option!

In the past, PageSeeder has supported a number of different relational database engines and this may be true again in the future. However, as of 2016, our preferred platform is MySQL. If it is important enough to financially contribute to testing / supporting a different relational database engine, please get in touch and we'll try to help.

In the meantime, please see the following Configuring MySQL

IMPORTANT: database and file system backup!

Warning!

PageSeeder DOES NOT backup or administer the host database or file system. If the integrity of either component is compromised, the application will not function. To minimize the potential for problems, users should follow all recommended backup and maintenance procedures.

In accordance with good administration practices, system owners should consider encrypting all backups and routinely test that restore procedures provide the expected results.

File System

Once in production, the critical folders to backup from the host operating system are:

pageseeder/documents
pageseeder/ps-publisher/WEB-INF/config
pageseeder/ps-publisher/WEB-INF/template
pageseeder/webapp/WEB-INF/config
pageseeder/webapp/WEB-INF/index
pageseeder/webapp/WEB-INF/template
pageseeder/woconfig

Second, stop existing SMTP servers

To provide comprehensive support for email messaging, the PageSeeder install comes with an SMTP server already integrated. To avoid the installation becoming confused, any existing SMTP servers must be stopped before the PageSeeder install commences. 

Windows

Depending on the version of Windows and whether there is an SMTP server on the machine, the accuracy and relevance of the following instructions will vary.  If you are unsure about any aspect of these directions, please consult someone with the appropriate level of technical expertise.

To stop the default Windows SMTP server, go to the Services Control Panel. Read or search the list of services for "Simple Mail Transport Protocol (SMTP)".

Select the 'Stop' option for this service, then change the 'Startup Type' to 'Manual'.

Linux

On supported Linux environments, one way to stop the SMTP server is by entering:

$ service sendmail stop
$ chkconfig --del sendmail
$ service postfix stop
$ chkconfig --del postfix

Begin installing PageSeeder

Windows Installation

  1. If not installed already, install Java 8 or later (see which version of java) as follows:
    • Go to https://www.oracle.com/java  and choose Java for Developers / Java SE.
    • Download the JDK or JRE .exe for windows (x64 for 64 bit) and run the installer.
  2. Download and run the latest pageseeder-x.exe file, available under the Install folder on the Download page.
  3. Once the install commences, follow the on-screen prompts.
  4. When the PageSeeder Developer Utility opens, click on Start.
  5. When PageSeeder starts, click on Setup and fill in the Setup form.

Linux Installation

Note

Running the PageSeeder installer requires CentOS, Fedora or Amazon Linux.

  1. If Java 8 or later is not installed (see which version of java) choose one of the following options:
    • OpenJDK (JDK 8) install 
      $ su -c "yum install java-1.8.0-openjdk"
      


      OR 

    • Oracle (e.g. download Server JRE 64-bit) Java Linux install 

      $ cd /usr/java
      $ tar zxvf server-jre-8u<version>-linux-x64.tar.gz
      $ rm server-jre-8u<version>-linux-x64.tar.gz
      $ cd /usr/bin
      $ mv java java.bak
      $ ln -s /usr/java/jdk1.8.0_<version>/bin/java java
      
  2. Install PageSeeder as follows:

    $ rpm -Uvh http://download.pageseeder.com/pub/rpm/pageseeder-repository-1.0-1.noarch.rpm
    $ yum install pageseeder
    
  3. Configure PageSeeder as shown below.
  4. For development use, press Enter to accept the default values, but for testing and production, use 80 for the website port or SSL encryption.
    $ sudo service pageseeder config
    
    Have you downloaded the MySQL Connector/J JDBC driver (y/n) [y]?
    
    Please locate the MySQL JDBC driver jar file
    /home/myuser/mysql-connector-java-5.1.32-bin.jar
    
    Please enter the API port used by the Publish Engine to communicate with PageSeeder [8282]
    
    Do you want to enable SSL on the PageSeeder server (y/n) [no]?
    
    Please enter the website TCP/IP port used by the PageSeeder server [8080]
    
    Please enter the Java options for the PageSeeder server [-Xmx512m -XX:MaxPermSize=128m]
    
    Please enter the port used by the SMTP mail server [2525]
    
    Stopping xinetd:                                           [  OK  ]
    Starting xinetd:                                           [  OK  ]
    To complete setup of the PageSeeder Server, please start the pageseeder service
    then go to http://myserver.com:8080/ps/weborganic/setup/setup.html
    
  5. If you chose a website port less the 1024 (e.g. 80 or 443 for SSL), then configure a proxy from this port to the API port (e.g. 8282). To do this see Configuring A Proxy.
  6. Add the following to the /etc/hosts file so PageSeeder can communicate with the Publish Engine:
    127.0.0.1    myserver.com
    
  7. Start the PageSeeder server as follows:
    $ sudo service pageseeder start
    
  8. Go to the URL for the Setup page in a web browser (e.g. http://myserver.com/ps/weborganic/setup/setup.html )

Note

You can reconfigure PageSeeder at any time by doing:

$ sudo service pageseeder stop
$ sudo service pageseeder config
$ sudo service pageseeder start

Installation Architecture

Below is a diagram of the installation architecture on Linux. The PageSeeder components should run as the PageSeeder user for better security so can only use ports above 1024. Xinetd is used to transfer incoming email from port 25 to port 2525.

The dashed lines show optional components:

  • to use default HTTP (port 80) or SSL (port 443) you need to configure Nginx as a reverse proxy. Nginx has various advantages, like displaying a maintenance page if PageSeeder is down and having PageSeeder and Berlioz under different domains on the same IP address.
  • otherwise, you can use ports above 1024 (e.g. 8080 and 8099) without Nginx.
  • Jetty and Berlioz are not included in the PageSeeder installer, see Website Engine for more information.

ps-install-architecture.png

Stopping and Starting PageSeeder

Windows

Use the Start-Stop Developer Utility under the PageSeeder program group.

If you have problems with the developer utility you can do the following at the command prompt or in a batch file (substitute your own JAVA_HOME path):

c:
cd \pageseeder\default\tomcat\bin
set JAVA_HOME=C:\Program Files\Java\jdk1.8.0_92
startup

To stop you can type shutdown at the command prompt or press Ctrl-C in the startup window.

Linux

Enter the following commands:

$ service pageseeder stop
$ service pageseeder start

Or to stop and then start:

$ service pageseeder restart

Uninstalling PageSeeder

Windows

Stop PageSeeder and then select PageSeeder > Uninstall [instance] from the Start menu.

Some document and config folders may need to be removed manually.

Linux

Enter the following commands:

$ service pageseeder stop
$ yum remove pageseeder

Some document and config folders may need to be removed manually.

Created on , last edited on