The Flamenco Project

Flamenco Documentation

File Layout and Permissions

This section describes the files that are installed into the Flamenco target directory.

Flamenco Directory

Six directories are installed into the Flamenco target directory:

With the exception of instances, all of these directories are readable and executable by all users and writable only by you (the user who performed the installation). The instances directory is writable by all users so that anyone can create a new instance, but also sticky so that other users cannot delete your instances.

Instance Directory

Each instance resides in a subdirectory of target/instances. Each instance directory contains the following files and directories, which are writable by all users so that any user (including the Web server user account) can run the WebKit server for the instance:

The instance directory also contains the following files and directories, which are writable only by the user who created the instance, not writable by all users.

Restricted Execution

Flamenco is normally set up so that anyone can start instances just by accessing any URL that would be generated by the instance. (Any URL that begins with the URL to the CGI script, followed by a slash, the name of the instance, and another slash, accesses a page generated by the instance.) Also, any user on the system where Flamenco resides can shut down a Flamenco instance by emptying the appserverpid.txt file.

If you do not want other users to be able to start or shut down a particular instance, turn off world-write permission for appserverpid.txt and turn off world-execute permission for flamenco-instance:

chmod go-w appserverpid.txt
chmod go-x flamenco-instance

These changes to the permissions will also prevent the CGI script from automatically starting up the instance whenever someone tries to access the instance; you will have to use flamenco start instance to start the instance.

Continue to the next section: Troubleshooting.