Cyphon Configurations

Fixtures

The cyphon/fixtures/starter-fixtures.json file contains some generic configurations to use when starting your Cyphon project. You can read more about fixtures in Django’s documentation.

Custom

The cyphon/custom directory provides a place to add custom modules for Cyphon admin pages and filter backends. See the documentation for the Django admin site and Django REST Framework filters to learn more.

Settings

The cyphon/settings directory contains configurations for Cyphon’s Django-based web framework, as well Cyphon-specific configurations. You can read more about Django settings in Django’s documentation.

conf.py

The conf.py file contains settings specific to your Cyphon instance.

At a minimum, should edit the conf.py file with the IP address and/or domain name for your host machine:

HOST_SETTINGS = {
   'ALLOWED_HOSTS': ['example.com', '127.0.0.1'],
   'CORS_ORIGIN_WHITELIST': ['example.com', '127.0.0.1'],
}

You should also change the Django SECRET_KEY to something unique. You can generate one here.

base.py

The base.py file contains Django settings common to both the Production Environment and Development Environment.

dev.py

The dev.py file contains Django settings specific to the Development Environment. At a minimum, you should configure the BASE_URL setting.

prod.py

The prod.py file contains Django settings specific to the Production Environment. At a minimum, you should configure the BASE_URL setting.

default.py

The default.py file contains generic settings that can be used when running services that require Cyphon apps, such as Cyphon’s message receiver.