Installation

1Prerequisite

To use Temma, you need web hosting using the PHP interpreter version 8.0 or higher.

Temma can use all the databases supported by the PDO extension, as well as the noSQL Redis database, and the Memcached cache server.

2Installation with Composer

If you have the Composer dependency manager installed on your computer, you can use it to create a Temma-based project.

To create a website project:

$ composer create-project digicreon/temma-project-web my_site

To create an API project:

$ composer create-project digicreon/temma-project-api my_api

The difference:

• A web project returns mainly HTML pages, and therefore embeds the Smarty template engine.
• An API returns JSON streams by default, and manages its authentication via public/private key pairs. It therefore does not embed Smarty, and activates the API plugin.

3Installation without Composer

If you don't have Composer installed on your computer, or don't want to use it, Temma provides an easy-to-use installation script. You can even simply clone a Git code repository.

3.1Stable version

To create your project based on the latest stable version of Temma:

$ curl -Ls https://temma.net/release | sh -

Or, for short:

$ curl -Ls temma.net/r | sh -

The script will prompt you for the name of the destination directory to be created. The default name is temma_project.

$ wget https://github.com/Digicreon/Temma/archive/refs/tags/2.12.0.tar.gz
$ tar xzf 2.12.0.tar.gz
$ mv Temma-2.12.0 my_project
$ chmod 777 my_project/log my_project/tmp

3.2Latest version of sources

You can download the latest versions of Temma sources. These sources are undergoing testing (which is why they are not yet part of a stable release) and may contain bugs.

Once again, an installation script is provided:

$ curl -Ls https://temma.net/release/latest | sh -

Or, for short:

$ curl -Ls temma.net/r/l | sh -

Once again, the script will prompt you for the name of the destination directory to be created. The default name is temma_project.

$ wget https://github.com/Digicreon/Temma/archive/main.tar.gz
$ tar xzf main.tar.gz
$ mv Temma-main my_project
$ chmod 777 my_project/log my_project/tmp

$ git clone git@github.com:Digicreon/Temma.git my_project
$ chmod 777 my_project/log my_project/tmp
$ rm -rf my_project/.git

3.3Install Smarty

If you use Temma to create an API without HTML page generation, you won't need the Smarty templating engine. Otherwise, Temma needs Smarty version 4 or higher (if you are using PHP 8.1, you will need Smarty 4.1 or higher; for PHP 8.2 and 8.3, you'll need Smarty 5 or higher).

Temma is compatible with Smarty versions 4 and 5. Please note that version 5 introduces evolutions that are not retro-compatible.

You can install Smarty in two different ways: either using Composer, or by downloading the archive by hand.

To install the latest stable version of Smarty with Composer, type this command from the project root (more information in the documentation):

$ composer require smarty/smarty

To install Smarty manually, download the archive (ZIP or TAR.GZ format) of the desired version. Unpacking the archive, you will see a libs/ (Smarty 4) or src/ subdirectory. Rename it smarty4 (Smarty 4) or Smarty (Smarty 5) and then move it inside your project's lib/ directory.

4Web server configuration

Once Temma has been installed, you need to configure the web server that will run your web application.
To do this, you can use Apache/Nginx configuration or .htaccess files.

4.1.htaccess files

The .htaccess files are necessary in case of shared hosting.
If so, you don't have to do anything. The files are already present (.htaccess at the root and www/.htaccess).

4.2Apache or Nginx server

Use the Apache or Nginx configuration if you have your own server (dedicated, virtual or Docker container).

You'll find example configurations (files etc/apache.conf and etc/nginx.conf), which you can modify to suit your needs.

You will also need to delete the existing .htaccess files:

$ cd my_project
$ rm -f .htaccess www/.htaccess

5Project tree

Here is the content of a Temma project:

my_project/
    bin/
    cli/
    controllers/
    etc/
        temma.php
        apache.conf
    lib/
        Temma/
        Smarty/
        smarty-plugins/
    log/
        temma.log
    templates/
    tmp/
    var/
    vendor/
    www/
        index.php

• bin: Contains utility programs.
• cli: Contains your command-line scripts.
• controllers: Main directory for your controllers.
• etc: Configuration directory
  • temma.php: Project configuration file.
  • apache.conf: "virtual host" configuration file, in the case of an Apache server.
• lib: Base directory containing the external libraries, but also your business objects.
  • Temma: The framework code (for installations without Composer).
  • Smarty (or smarty4): Smarty template engine (for installations without Composer).
  • smarty-plugins: Smarty plugins offered by Temma.
• log: Directory containing the log files.
  • temma.log: Project log file.
• templates: Directory containing the templates.
• tmp: Directory of temporary files.
• var: Optional directory, which can contain the data files of your application.
• vendor: This directory exists if you have installed Temma using Composer, or if you have loaded external libraries with Composer.
• www: Root directory of the website, containing all CSS, Javascript and images files.
  • index.php: Main PHP script, which starts the framework.