Ceptor Docs

Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Tip

This Getting Started guide shows an overview of which files are available in the distribution, where they are located, which port the default configuration listens on etc.

You should also read at least these:

Ceptor Console

How a requests flows through Ceptor

Gateway Concepts

Create an Authentication Application within Ceptor Gateway


Installation

Standalone

Installation can be done in a number of ways, you can unzip the .zip file distribution to any directory and just launch Ceptor using the launcher scripts in the bin directory, or you can install using one of the platform installers which provides a better integration with your platform (e.g. Windows Start Menu), and installs as a Windows or Unix service.

...

  • licenses
    Contains license information about Ceptor, and the open source libraries used by parts of Ceptor.
  • documentation
    Contains documentation about using various parts of Ceptor - note that this directory no longer contains complete documentation, but only API documentation, Javadoc etc. - refer to the online documentation at https://asseco-dk.atlassian.net/wiki instead.
  • bin
    Binary files - contains a bootstrap loader that starts a Ceptor server or Ceptor Dispatcher/Gateway instance. The classpath will be set to the following directories, in the listed order: classes, patches*.jar, lib*.jar, extlib*.jar, plugins*.jar
  • classes
    Classes directory placed first in classpath - contains configuration files for logback - here you can enable/disable logging for specific classes or you can redirect logging to other locations.
  • patches
    Here, any eventual patches for specific bugfixes can be stored, any .jar files in this directory are loaded before the rest.
  • lib
    Contains Ceptor .jar files.
  • extlib
    External libraries, such as logback / log4j. See licences/readme.txt for a list of files and for the license information for each.
  • extlib_extras
    Additional external libraries, these are not added to the classpath by default, but can be added by specifying the extraclasspath attribute on classloader definitions in the launcher XML file.
  • plugins
    Place your own Ceptor plugins in this directory.
  • config
    Contains configuration for Ceptor servers, and startup scripts used by the bootloader to launch Ceptor server instances.
    Contains the following files and subdirectories:
    • ceptor-security.xml
      List of users, groups and access rights for the Ceptor Console.
    • ceptor-configuration.xml
      Main Ceptor server configuration - contains configuration used by all modules.
    • ceptor_launch.xml
      Launcher configuration used by the bootstrapper to start a Ceptor Server instance.
    • configuration-backup
      Backup of the configuration will be stored here, whenever changes are made via the administration interface.
    • eticket
      Contains certificates and samples for using eticket / NetID.
    • filelogin
      Files for specifying ACLs to applications, users' group and protected URLs, used by the sample authorization plugin, other plugins might use other datastores.
    • users
      Sample users used by the sample authentication plugin - typically used for development/testing when a database or other user datastore is not available.
    • x509
      Contains various certificates and sample keys for OCES Digital Signature and DanID / NemID integration.
    • xdomain
      Sample key files for cross-domain session sharing.
  • ppserver
    Contains resources used by the Ceptor server, such as web apps for the Administration interface (images, stylesheets etc.), user administration and webapp/configuration for the web services interface to Ceptor.
    • console
      Ceptor Console runtime  and web application files.
    • developerportal
      Ceptor Developer Portal runtime and web application files.
    • useradmin
      User administration web application runtime files.
    • webserviceswebapp
      The webapp folder for the web services webapp if launched
  • dispatcher
    Contains resources used by the dispatcher, e.g. key file containing SSL server certificate.
  • gateway
    Contains additional libraries used by the Ceptor gateway. 
  • auth
    Contains static html/javascript resources for an authentication application that uses the CeptorAuthenticate API to authenticate, self-register or reset password for endusers. Please see Create an Authentication Application within Ceptor Gateway for more information.
  • logs
    Log files are generated and stored here.
  • samples
    Sample configurations, database scripts etc.
    Samples have the following subdirectories:
    • integration
      Contains the agents for various application servers, as well as the .NET Agent and sample IIS application.
    • demoapp
      Sample demonstration application that uses many Ceptor APIs and demonstrates how to utilize these APIs in your own applications, e.g. it contains samples for authentication users in various ways using userid/password, x.509 certificates, oces applets etc. Source code for the sample application is included.
      Important: The demo app requires a full java JDK to be installed in order to work – it will not work with the JRE bundled with Ceptor. Oracle's license prevents us from bundling the JDK, so you will need to download that from oracle.
    • database
      Contains database creating SQL scripts and scripts for inserting test data for the various supported databases used by the Identity Manager / UserAdministration component.
    • configuration
      Contains various snippets of the configuration used to demonstrate e.g. cluster setup, or how to add a generic .war file to the Ceptor services launcher.
  • statistics
    Statistics stored in the statistics server are stored here.
  • testdatabase
    Test cloudscape databases used by the sample configuration for user administration. Contains users, groups, acls, organisations etc.
    The sample configuration will also put the API management database in this folder.
  • useradminapp
    User Administration application (thick java client), communicates with useradmin server which uses the database located in testdatabase to administer users.
  • temp
    Temporary directory, used for cache files etc.
  • jcepolicy
    Unrestricted JCE Policy files, for use with Oracles JDK

...