Flocl: Flickr™ Local

Understanding .flocl.xml

The configuration file for Flocl is essentially a set of name/value pairs. For example:

<flocl xmlns="http://flocl.sourceforge.net/ns/config">
  <info>/share/flocl/flickr.xml</info>
  <root>/share/flocl/</root>
  <webroot>/share/flocl/</webroot>
  <mrucount>25</mrucount>
  <email>your@email.address</email>
  <api_key>your-api-key</api_key>
  <shared_secret>your-api-key-shared-secret</shared_secret>
  <auth_token>your-auth-token-for-api-key</auth_token>
</flocl>

Each element contains a value used by the Flocl scripts:

info

The name of the XML file that contains information about your Flickr photographs.

root

The name of the directory where your local Flickr is installed.

webroot

The URI prefix needed to access your local Flickr. If you're going to access your local Flickr installation with file: URIs, this should be the same as the root value.

If you're going to use a local web server, this should be the the URI path prefix necessary to reach the root of your local Flickr.

mrucount

Flocl displays this many “most recently updated” photographs on the home page.

email

Your primary email address, according to Flickr.

api_key, shared_secret, and auth_token

Your API key and associated authentication data.

All of the values are required.