WebGL (TM) Canvas Library

Installing the Library

Installation on a Web Server

The library is deliverd as a zip file. Upload the zip file to your private protected web server and unpack it into the document root directory (or alternatively upload the unpacked zip). The zip file contains a single top-level folder named taccgl062. Installation of taccgl on a public web server is discussed below. Afterwards point your browser to /taccgl062/index.html on your web site. On successful installation this shows some simple examples.

Multiple versions of the library can coexist on a server, see the Upgrading section below.

Local Installation

The library is deliverd as a zip file. You can simply unpack the zip file in a directory of your choice and then open the index.html file contained therein with your web browser. Opening the index.html file while it is still stored in the zip will not work, you need to completely unpack the zip file.

Note, however, that some browsers (e.g. chrome and webkit) apply stronger security checks for local access and so not all features will work locally unless you start the browser with specific options. Therefore we would recommend to install a local web server and then follow the "Installation on a Web Sever" below. If you nevertheless install it locally, you need to use the options without them many examples will silently stop working (i.e. there are security messages on the debugging console only) which can be very frustrating. Please go ahead and read about the options.

Installation on a Public Web Server

After installation of the zip file on a web site, besides the library itself, some simple documenation and example files appear on the web site. Since this is not normally intended on a public web site it is recommended to install the zip on a protected private test site only. Afterwards just deploy the taccgl.js file to a public web server.

The doc, parallax-scrolling-examples, and pic directories and the README, README.md, index.html, LICENSE, and WARNINGS files are not needed for normal operation.

The files in the src subdirectory are needed for debugging and development of the library and contain an uncompressed version of the library. They are not needed on a production server, unless debugging is needed.

Final Installation Steps

On a production server we recommend to enable gzip compression (e.g. using the apache deflate module) to compress the library and the 3D model files and so speed up page loading times.

Upgrading from older Versions

You can install multiple versions of the library at the same time. After installation of a new version, you need to update the version number in the <script> statements of pages using the old version, see Including the Library. Only afterwards, you can delete the old version by deleting the corresponding /taccgl??? directory.

WebGL™ is a trademark of the Khronos Group Inc.