Welcome to the documentation for administrators

Table of contents

The documentation for administrators describes all aspects of FirstSpirit administration as well as the required administration environments and is, therefore, exclusively aimed at administrators.

FirstSpirit provides all users, depending on their tasks, with a client which has been precisely adapted to respective requirements. Therefore, FirstSpirit offers multiple clients for varying tasks and users. Generally speaking, a distinction is made between editorial environments and administration environments. While the FirstSpirit editorial environments support the work of editors and template developers, the administration environments have been primarily designed to monitor and configure FirstSpirit.

  • FirstSpirit ServerManager: The FirstSpirit ServerManager is a Java application with a convenient, swing-based user interface which supports the FirstSpirit administrator for general, administrative FirstSpirit tasks. For example, the user interface can be used to create and configure new FirstSpirit projects. More extensive functions are possible in addition to the general tasks. The ServerManager can, e.g., be used to define users or integrate existing identity management systems, such as LDAP or Active Directory. Analogue to the SiteArchitect, the ServerManager is started and updated via the FirstSpirit Launcher.
  • FirstSpirit ServerMonitoring: The browser-based FirstSpirit ServerMonitoring is a web application for monitoring the FirstSpirit Server. Analogue to the ContentCreator, FirstSpirit ServerMonitoring is operated via a web browser.
  • FirstSpirit JMX-Konsole: Using Java Management Extensions (JMX) it is possible to monitor Java applications in a standardised manner. While the primary task of FirstSpirit ServerMonitoring is to manually monitor a FirstSpirit Server, the JMX Console is used for automatic monitoring and can be perfectly integrated into an existing, company-wide monitoring system, if required. In principle, the JMX Console can also be used interactively. Compared to ServerMonitoring, finer granular information is provided.

Important This document is provided for information purposes only. e-Spirit may change the contents hereof without notice. This document is not warranted to be error-free, nor subject to any other warranties or conditions, whether expressed orally or implied in law, including implied warranties and conditions of merchantability or fitness for a particular purpose. e-Spirit specifically disclaims any liability with respect to this document and no contractual obligations are formed either directly or indirectly by this document. The technologies, functionality, services, and processes described herein are subject to change without notice.

FirstSpirit architecture

(Please click twice for viewing figure in original size.)

FirstSpirit™ is a classic client/server application which is entirely based on Java and web technology. Access to the FirstSpirit Server occurs either via the FirstSpirit SiteArchitect or the FirstSpirit ContentCreator. Communication between the FirstSpirit-Client and the FirstSpirit Server is, depending on the application scenario, either based on HTTP(S) using an application server, or on the direct application of TCP.

The live system actually provides contents to the end user. The FirstSpirit Server does not necessarily have to be connected to the live system all the time. If there is no permanent connection to the live system, all the data required by the live system is transferred during deployment, so that no direct interaction between the live system and the FirstSpirit Server is necessary.

Important FirstSpirit is not a universal “out-of-the-box” product, but continuously developed software. New functionalities and customer suggestions are constantly integrated and realised. These constant updates can only be reflected in the documentation to a limited degree. This may result in some figures in this documentation varying from the current FirstSpirit view. Please do not be confused by this, and just follow the instructions as normal.

Structure of this documentation

The structure of this documentation is based on the functions provided by the administration environments.

  • System Requirements and Installation: This chapter offers a brief overview of the FirstSpirit installation. Detailed, separate documentation regarding this topic can be found in the “Introduction (→Installation Instructions)”.
  • FirstSpirit Server control: This chapter describes the control of the FirstSpirit Server under Unix and Windows operating systems.
  • FirstSpirit Server configuration: The FirstSpirit Server is configured via configuration files located in the installation directory of the FirstSpirit Server. These configuration files and their parameters are described in this chapter.
  • Backing up and recovering the FirstSpirit Server: This chapter describes methods for backing up data and recovering the FirstSpirit Server.
  • Updating the FirstSpirit Server: Only a current FirstSpirit version can ensure that all FirstSpirit functions will be available and that the software will run as well and reliably as possible. We therefore recommend updating existing FirstSpirit Servers regularly and promptly. This chapter describes different options for keeping FirstSpirit up-to-date.
  • FirstSpirit web application configuration: Configuration of the FirstSpirit web applications – especially project requirements, configuration and limitations of the ContentCreator – is described in this chapter.
  • FirstSpirit start page: The FirstSpirit start page is a web application for starting the FirstSpirit editorial and administration environments.
  • FirstSpirit ServerManager: This chapter describes the project-wide functions which can be called via the ServerManager menu bar. The FirstSpirit ServerManager supports the general, administrative FirstSpirit tasks of the FirstSpirit administrator.
  • FirstSpirit ServerMonitoring: The browser-based FirstSpirit ServerMonitoring is used to monitor the FirstSpirit Server and displays current operating parameters (e.g. number of users, memory load).
  • FirstSpirit JMX Console: Using Java Management Extensions (JMX) it is possible to automatically monitor Java applications. The JMX Console can be perfectly integrated into existing, company-wide monitoring, if required.
  • Secure deployment via rsync and ssh: Combined utilisation of the external service programs rsync and ssh is recommended for deployment via unsecured Internet connections or networks with low bandwidth.
  • User permission configuration: This chapter outlines the mechanisms for user permission assignment and permission check provided by FirstSpirit and their precise application.

Supplementary documentation

© 2005 - 2020 e-Spirit AG | All rights reserved. | FirstSpirit 2020-08 | Data privacy | Imprint | Contact us