===================
Configuration Guide
===================

.. toctree::
   :hidden:

   config.rst
   policy.rst
   sample_api_paste.rst
   sample_config.rst
   sample_policy.rst

The configuration for freezer-api lies in below described files.

Configuration
-------------

Freezer API has a main config file ``freezer.conf``. You can
find a reference to it below:

* :doc:`Config Reference <config>`: A complete reference of all
  config points in freezer-api and what they impact.
* :doc:`Sample Config File <sample_config>`: A sample config
  file with inline documentation.


Policy
------

Freezer API, like most OpenStack projects, uses a policy language to restrict
permissions on REST API actions.

* :doc:`Policy Reference <policy>`: A complete reference of all
  policy points in freezer-api and what they impact.
* :doc:`Sample policy File <sample_policy>`: A sample policy
  file with inline documentation.


API configuration settings
--------------------------

* :doc:`API configuration <sample_api_paste>`: A complete reference of API
  configuration settings.
