Setup and integration manual


Preamble

In order to use CMS Ametys as closely as possible to your needs and to benefit from all its features, you need to customize it to suit your graphic, functional and technical environment.

In concrete terms, this means :

 

First of all, we advise you to read the user manual and browse the application to familiarize yourself with its features.

Before starting to customizeAmetys, it is advisable to be familiar with its software architecture. As Ametys is a modular software package, each application can use, in addition to the software base, a certain number of modules (in the Ametys vocabulary, they are called "plugins"), most of which are themselves configurable.
To configure and customize (particularly graphically) these plugins, please refer to their documentation. For all plugins supplied as standard by Ametys, these can be found in the plugins documentation area.
This manual covers only the Ametys base, without the additional plugins .

 

Technical requirements

This parameterization and integration manual covers all the customization ofAmetys that does not require development skills. The aim is not to add new functionalities, but to act on the many customization possibilities offered by existing functions.

The skills involved are the modification of XML files (for parameterization) and XSLT style sheets (for graphic integration). Knowledge of XHTML/CSS is obviously required for rendering, but Ametys brings no restrictions in this respect.

Project creation

The 1st step in integrating CMS Ametys is to create your project.

For a quick start, download the Windows (.exe) or Linux (.sh) version of the demo application, or the Java version. This version contains plugins, two graphic templates ("demo" and "blog") and sample content.

Windows version

Install the application by double-clicking on the downloaded file; by default, installation takes place in the C:/Ametys directory.

You will then work in the C:/Ametys/webapp/cms for the back-office application and C:/Ametys/webapp/site for the front-office application.

Linux version

Run the file .sh downloaded.

#chmod u+x ametys-3.X.X.sh 
#./ametys-3.X.X.sh 

To find out more
For those of you who wish to use your own application server, you can download the deployment application zip.
Then unzip it on your server; it contains 2 directories: cms and site. Many plugins are already included in this version, as well as two skins ("demo" and "blog").
To continue, follow the installation manual (it's advisable to read it in its entirety before starting, to validate prerequisites for example). For integration purposes,Apache is not required.

 

Project organization

A Ametys project is organized as follows:

The cms directory contains files for the CMS application, i.e. the application used by contributors. It is made up of the following directories:

  • plugins contains the project's default plugins as well as those that have been redefined
  • skins Site template directory: contains the site template(s), i.e. the graphic charts. This directory is only present in the case of a Web project.
  • WEB-INF contains application settings
    • config contains application configuration files
    • data The repository may contain site data. The downloaded application contains the content database (repository), the derby database (db) and the index files.
    • i18n contains internationalization files application
    • lib contains the libraries needed for the application (.jar)
    • logs contains application log files
    • param contains application parameter files
    • scripts contains one directory per database type (Oracle, MySQL, Derby, PostgreSQL)each containing scripts for creating and/or updating the SQL tables required by the application.

The site directory contains the site application files. It is made up of the following directories (relatively similar to those of CMS):

  • plugins contains the project's default plugins as well as those that have been redefined 
  • WEB-INF contains application settings
    • config contains application configuration files
    • data contains application data, in particular the cache of static pages
    • i18n contains internationalization files application
    • lib contains the libraries required for the application (.jar)
    • logs contains application log files
    • param contains application parameter files

 

  

 

Back to top

Setup and integration manual