TeamCal Neo
  • TeamCal Neo
    • Feature Comparison
    • TeamCal Neo License
    • Support
  • Installation
  • Quick Start Guide
  • Administration
    • Absence Types
      • Absence Allowance
      • Absence Type Edit
      • Absence Type Icon
    • Absence Patterns
    • Allowance Bulk Edit
    • Calendar Options
    • Database Management
      • TeamCal Pro Import
    • Declination Management
      • Absence Threshold
      • Before Date
      • Period 1-3
      • Scope
    • Framework Configuration
      • License
    • GDPR
    • Groups
      • Group Edit
    • Holidays
      • Holiday Edit
    • Permissions
      • Group Manager Permission
    • PHP Info
    • Regions
      • Region Calendar
    • Responsive Display
    • Roles
    • System Log
    • Users
      • User Edit
      • User Import
    • LDAP Authentication
    • Two Factor Authentication
  • User Guide
    • Attachments
    • Calendar (Month)
      • View Calendar (Month)
      • Edit Calendar (Month)
      • Edit Group Calendar (Month)
      • Edit Daynotes
    • Calendar (Region)
    • Calendar (Year)
    • Dark Mode
    • Language
    • Messages
    • Remainder Page
    • Statistics
      • Absence Type Statistics
      • Absence Statistics
      • Presence Statistics
      • Remainder Statistics
      • User Absence Summary
    • View Profile
    • Two Factor Authentication
Powered by GitBook
On this page
  • Requirements
  • Creating the database
  • Download and copy the TeamCal Neo files
  • TeamCal Neo Installation
  • After the installation
  • Running the installation again
  • Manual Installation

Installation

Requirements

You can run TeamCal Neo on your own web server if it supports:

  • PHP 8.1

  • MySQL 5.5+ (with PHP_pdo_mysql extension enabled)

You also need access to your web server in order to copy files there and you need to have the possibilty to create a MySQL database that your web server can access.

Creating the database

Login to your web hosting front end and create a MySQL database. You might want to give it a speaking name like “TCNeo”. Write down the

  • Database server URL

  • Your database name

  • Your database username

  • Your database password

Do not use an existing TeamCal Pro database. TeamCal Neo is not compatible with it. If you want to use data from your TeamCal Pro instance you can import them later in Database Management.

Download and copy the TeamCal Neo files

You can download the latest release from the GitHub repositories:

You can run TeamCal Neo either from

  • the root directory of your domain (Example: http://www.mydomain.com)

  • a sub-directory of your domain root (Example: http://www.mydomain.com/tcneo)

  • a subdomain root directory (Example: http://tcneo.mydomain.com)

Copy all files into the directory of your liking. You can either unzip the archive locally first and copy all files via FTP to your web server or you can copy the ZIP file to your web server and unzip it with a Shell access.

TeamCal Neo Installation

After you have created your database and copied the files, direct your browser to the URL you chose for TeamCal Neo.

TeamCal Neo will automatically display the installation page:

Enter the database information you have written down, select the data set you want to use and confirm the license agreements.

Then click [ Install ].

TeamCal Neo will do the rest for you.

After the installation

After the installation is complete, TeamCal Neo will reload. You will see the following error message:

TeamCal Neo will not start if the installation script “installation.php” still exists in the TeamCal Neo directory. This is a security measure.

Rename the file to “installation.php.org” for now.

Reload TeamCal Neo and check its basic functionality.

If all is ok, you can delete the installation script file.

Running the installation again

There might be situations when you want to run the installation again. In such a case, edit the file “config/config.app.php” and set the app_installed parameter to 0:

//=============================================================================
/**
 * APP INSTALLED
 *
 * A flag indicating whether the installation script has been executed. 
 * 0 = Not run yet
 * 1 = Was run
 * Set this to 0 if you want to run the installation.php script again.
 * If not, it is recommended that you delete the installation.php file.
 */
define('APP_INSTALLED', "0");

Copy the original “installation.php” from the ZIP file back to your TeamCal Neo directory on the server.

Direct your browser to the TeamCal Neo URL. The installation script will start again.

If you only want to reset TeamCal Neo to the sample data, that can also be done more conveniently under Administration → Database Management → Database reset

Manual Installation

In case you are experiencing problems with the installation script, you can use the following manual steps to install TeamCal Neo.

  1. Create the database you want to use

  2. Import the sample database located in sql/sample.sql

  3. Edit config/config.db.php and enter the details for your database

  4. Edit config/config.app.php and set

    define('APP_INSTALLED', "1");
  5. Rename or remove the installation.php file

  6. Navigate your browser to the index.php file

PreviousSupportNextQuick Start Guide

Last updated 7 months ago

Even though the installation script is kept as generic as possible, there are environments in which you might encounter problems with it. In that case, refer to the chapter below.

TeamCal Neo
TeamCal Neo Basic
TeamCal Neo (Legacy)
Manual Installation