Tutorials - Installation


Apache Web Server (2.2.29 +) with PHP (5.6.2 +)
(any other configuration might also be fine, but this one has been tested)

If you don't have a server you can try FrameTrail locally using the tools XAMPP or MAMP.

Please note that you can use FrameTrail "read-only" locally without any server, as long as your browser supports local Ajax requests (there are known issues with Chrome, but Firefox should work in most cases). Of course you won't be able to use the editing features.


Installing FrameTrail basically means copying the downloaded package to your server and follow the instructions on the screen. However, a little knowledge of server architectures is helpful, as you might need to change things like file and folder permissions.

  1. git clone https://github.com/OpenHypervideo/FrameTrail or Download ZIP to your server directory (i.e. http://example.com/DIRECTORY-NAME or http://localhost/DIRECTORY-NAME if you're using XAMMP, MAMP etc. for a local setup).
  2. Open your server directory in your favourite browser.
  3. Follow the instructions to define a global master password and configure your FrameTrail instance.

Adding a new project

  1. Go to http://example.com/DIRECTORY-NAME/projectmanager and login with your global master password
  2. Click "Add New Project" and follow the instructions

Now something very important:

Every project has a separate user base and resource archive. When you create a new project, you can add and manage users for that project. Those users only have access to that very project.

This means that users always need to register per project (including you). An account in one project doesn't exist in the other projects. Just see it as completely different installations, which you can manage through the project manager ;)

Adding a new hypervideo

  1. Select your project in the Project Manager or go to http://example.com/DIRECTORY-NAME/player/?project=PROJECTID and login
  2. In the titlebar, click "New Hypervideo" and follow the instructions

Adding resources

  1. In the titlebar, click "Manage Resources" to open the Resource Manager
  2. Click "Add Resource" and follow the instructions
  3. When your resource has been added, you and other users can use it as basis for new Hypervideos or for Overlays & Annotations

That's it! You might want to read the Getting Started Tutorial now.


To update your FrameTrail instance, download the latest release and copy / replace it on your server. Just make sure you don't overwrite the /_data folder, as that contains your personal settings and project data.