diff --git a/README.md b/README.md index d45d5d5a..21f2cce7 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ -# Index +# LIL City ### [Обзор архитектуры](docs/overview.md) ### [Описание API](docs/api.md) ### [Работа с сервисом оплат Paymentwall](docs/paymentwall.md) ### [Роли и права](docs/roles.md) +### [Конфигурирование сервиса](docs/config.md) ### [Развертывание приложения](docs/deploy.md) diff --git a/docs/config.md b/docs/config.md new file mode 100644 index 00000000..7a87f040 --- /dev/null +++ b/docs/config.md @@ -0,0 +1,27 @@ +# Конфигурирование +Конфигурирование сервиса осуществляется с помощью `.env` файла. + +В корневой папке репозитория есть пример конфигурации `.env.example`. + +* **DEBUG** - Включение режима отладки Django. +* **ALLOWED_HOSTS** - Список адресов, с которых разрешён доступ. * - доступ разрешен с любого адреса (не рекомендуется). Пример: `ALLOWED_HOSTS=127.0.0.1,lilcity.9ev.ru,lil.city`. +* **PORT** - Порт бэкенд сервиса. По умолчанию - `8000`. +* **CORS_ORIGIN_WHITELIST** - Список адресов, не связанных с сервисом, с которых разрешен доступ. +* **LANG** - Язык сервиса. По умолчанию - `ru_RU.UTF-8`. +* **POSTGRES_DB** - Название базы данных. +* **POSTGRES_USER** - Имя пользователя базы данных. +* **POSTGRES_PASSWORD** - Пароль пользователя базы данных. +* **PGDATA** - Папка хоста для монтирования файлов базы данных. +* **DJANGO_SETTINGS_MODULE** - Файл настроек Django. +* **DATABASE_SERVICE_HOST** - Адрес или название сервиса базы данных. +* **SECRET_KEY** - Секретный ключ Django. +* **MAILGUN_API_KEY** - Ключ API Mailgun. +* **MAILGUN_SENDER_DOMAIN** - Домен отправки Mailgun. +* **DEFAULT_FROM_EMAIL** - E-mail для указания в поле "От". +* **TWILIO_ACCOUNT** - Ключ аккауна Twilio. +* **TWILIO_TOKEN** - Токен аккауна Twilio. +* **TWILIO_FROM_PHONE** - Номер телефона, на который подменяется отправитель смс. +* **PAYMENTWALL_APP_KEY** - Ключ приложения Paymentwall. +* **PAYMENTWALL_SECRET_KEY** - Секретный ключ Paymentwall. +* **MIXPANEL_TOKEN** - Токен Mixpanel. +* **RAVEN_DSN** - Адрес для отправки ошибок в Sentry.