Tutorials - Installation

Need help?

Please get in touch via Twitter (@FrameTrail) or mail us at joscha.jaeger | at | filmicweb | dot | org if you need help setting up a FrameTrail project. We offer both technical assistance and consulting. If you have ideas for a joint project / collaboration that involves FrameTrail, let's talk!

Prerequisites

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.

More information about how to use FrameTrail as a "stand-alone" app without a server will be provided soon in the Advanced Use tutorial.

Setup

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. https://example.com/DIRECTORY-NAME or https://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 an administrator account and configure your FrameTrail instance.

Adding your first hypervideo

  1. Click the Edit Button on the top right and login with your administrator account details.
  2. In the titlebar, click "New Hypervideo" and follow the instructions

Adding resources

  1. Click the Edit Button on the top right and login with your administrator account details.
  2. In the titlebar, click "Manage Resources" to open the Resource Manager
  3. Click "Add Resource" and follow the instructions
  4. 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.

Updates

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.