<commit_before>=============
Empty project
=============

Getting started
---------------

The service may be wrapped using NewRelic. In this case, launch the production service with the
following command:

.. code-block:: bash

    $ newrelic-admin run-program uwsgi

Altering the configuration
--------------------------

You may set the following variables to alter the default behavior of the app:

* ``NEW_RELIC_CONFIG_FILE``: set the NewRelic configuration file ``newrelic.ini``
* ``SENTRY_DSN``: set the ``dsn`` value, collected in the Sentry setup page
* ``UWSGI_SOCKET``: set the unix socket path
* ``UWSGI_PROCESSES``: set the number of uWSGI processes<commit_msg>partial variables in app README; many are still missing<commit_after>=============
Empty project
=============

Getting started
---------------

The service may be wrapped using NewRelic. In this case, launch the production service with the
following command:

.. code-block:: bash

    $ newrelic-admin run-program uwsgi

Settings
--------

``{{ cookiecutter.app_name }}`` requires the following settings in order to work as expected.

Core
~~~~

These environment variables are required when using the ``production.py`` settings;
in development or testing mode, they are not required and no SSL connection will be used.

* ``DJANGO_SECURE_SSL_REDIRECT`` (default: ``True``)
* ``DJANGO_SESSION_COOKIE_SECURE`` (default: ``True``)
* ``DJANGO_ALLOWED_HOSTS`` (default: ``None``)
* ``NEW_RELIC_CONFIG_FILE``: sets the NewRelic configuration file ``newrelic.ini``
* ``SENTRY_DSN``: sets the ``dsn`` value, collected in the Sentry setup page
* ``UWSGI_SOCKET``: sets the unix socket path
* ``UWSGI_PROCESSES``: sets the number of uWSGI processes

Services
~~~~~~~~

These environment variables define the external services access. You may set
these values according to your development environment. If you are using ``docker``,
just change ``DATABASE_URL`` and ``CACHE_URL`` with your linked container URLs.

* ``DATABASE_URL`` (default: ``postgres://devel:123456@127.0.0.1:5432/runaway``)
* ``CACHE_URL`` (default: ``redis://127.0.0.1:6379/1``)
* ``DJANGO_EMAIL_BACKEND`` (default: ``django.core.mail.backends.console.EmailBackend``)
* ``EMAIL_HOST``
* ``EMAIL_HOST_PORT``
* ``EMAIL_HOST_USER``
* ``EMAIL_HOST_PASSWORD``

Altering the configuration
--------------------------

You may set the following variables to alter the default behavior of the app:
{'fraction_non_alphanumeric': 0.16577319587628866, 'fraction_numerical': 0.0111340206185567, 'mean_word_length': 4.463963963963964, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 2, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '805223', 'n_tokens_mistral': 743, 'n_tokens_neox': 708, 'n_words': 254}