Configuration
=============

AerisCloud comes with several features that are available only through the
``config`` command in ``aeris`` (see also :ref:`aeris-config`). The
configuration file can be found in the config folder of your operating system
(``~/.config/AerisCloud`` for Linux and ``~/Library/Application Support/AerisCloud``
for OSX) under the name ``config.ini``.

config
------

This is the main configuration block and dictates basic features of AerisCloud

.. _config-projects_path:

``config.projects_path``
^^^^^^^^^^^^^^^^^^^^^^^^

Contains the path to the folder where projects are held and searched for when
running the :ref:`aeris-fetch` or :ref:`aeris-goto` commands, it is also used
when running the auto-completion scripts. ::

  config.projects_path = /home/user/AerisCloudProjects

.. _config-default_organization:

``config.default_organization``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The name of the default organization to use when searching for playbooks and
roles, see :ref:`cloud-organization`. ::

  config.default_organization = aeriscloud

.. _config-basebox_bucket:

``config.basebox_bucket``
^^^^^^^^^^^^^^^^^^^^^^^^^

If your organization has it's own basebox repository for Vagrant, it should be
set here so that the :ref:`aeris-init` command might be able to set it in
your projects. See :ref:`aeris-box` ::

  config.basebox_bucket = organization-boxes

*Note:* This is the AWS S3 bucket name. The required URLs will automatically be generated from that name.

.. _config-raven:

``config.raven``
^^^^^^^^^^^^^^^^

AerisCloud can uses `sentry`_ for logging application crashes and issues, if
you wish to set this feature, you can set this configuration variable to the
proper raven URL ::

  config.raven = https://access_token@app.getsentry.com/project_id

.. _sentry: https://getsentry.com/welcome/

github
------

GitHub integration allows you to automatically fork and fetch projects from
GitHub using the command-line, see :ref:`aeris-fetch`

.. _github-enabled:

``github.enabled``
^^^^^^^^^^^^^^^^^^

Enables Github integration when set to **true**, when enabled both ``github.token``
and ``github.organizations`` should be set. ::

  github.enabled = true

.. _github-token:

``github.token``
^^^^^^^^^^^^^^^^

A valid GitHub token generated via the `github tokens`_ page, only the ``repo``
scope is necessary. ::

  github.token = <64-bytes string>

.. _github tokens: https://github.com/settings/tokens

.. _github-organizations:

``github.organizations``
^^^^^^^^^^^^^^^^^^^^^^^^

A list of GitHub organizations, separated by commas. ::

  github.organizations = AerisCloud,Wizcorp

aeris
------

`Aeris.cd`_ is a lightweight reverse proxy application written in node.js that
allows developers to share their application with their colleagues in an
easy way thanks to direct integration with AerisCloud.

.. _Aeris.cd: https://github.com/Wizcorp/aeris.cd

.. _aeris-url:

``aeris.url``
^^^^^^^^^^^^^

The url to your local ``aeris.cd`` instance. ::

  aeris.url = aeris.cd

.. _aeris-email:

``aeris.email``
^^^^^^^^^^^^^^^

The email used to signup on your ``aeris.cd`` instance. ::

  aeris.email = myself@my-org.tld

.. _aeris-token:

``aeris.token``
^^^^^^^^^^^^^^^^

An access token generated by ``aeris.cd``. ::

  aeris.token = <40-bytes string>