Here are the configuration parameters in base.py. These are largely django and wagtail settings. Those in italics should be kept as they are, unless you have a compelling reason to change them.
PROJECTDIR = os.path.dirname(os.path.dirname(os.path.abspath(_file))) The directory the project is in BASE_DIR = os.path.dirname(PROJECT_DIR) The base directory of the project APP_NAME = env.get('APP_NAME', 'hypha') The name of the application
DEBUG = False/True : This will display detailed error pages when errors are encountered. Make True only in development/testing environments.
SECRET_KEY = env['SECRET_KEY'] The secret key should be a large random value, unique to one deployment, and not committed to source control ALLOWED_HOSTS = env['ALLOWED_HOSTS'].split(',') These are the hosts that this django installation is allowed to serve.
Organisation name and e-mail address, used in e-mail templates etc. These are hypha-specific settings
EMAIL_HOST = env['EMAIL_HOST'] Name of host for emails being sent
EMAIL_PORT = int(env['EMAIL_PORT']) Port used for sending emails EMAIL_HOST_USER = env['EMAIL_HOST_USER'] Username for sending emails EMAIL_HOST_PASSWORD = env['EMAIL_HOST_PASSWORD'] Password for sending emails EMAIL_USE_TLS = True Use TLS encryption EMAIL_USE_SSL = True Use SSL encryption EMAIL_SUBJECT_PREFIX = env['EMAIL_SUBJECT_PREFIX'] Prefix for all subject lines SERVER_EMAIL = DEFAULT_FROM_EMAIL = env['SERVER_EMAIL'] Default from address for emails
Application definition These are django configurations
Details on these configurations can be found here
INSTALLED_APPS = [ ... add any additional apps here]MIDDLEWARE = [... add any additional middleware here]ROOT_URLCONF = 'hypha.urls'TEMPLATES = [ ... add any additional templates here]FORM_RENDERER = 'django.forms.renderers.TemplatesSetting'WSGI_APPLICATION = 'hypha.wsgi.application'
Messaging Settings - these settings are for messaging integration, like Slack. Most should probably be set via environment. Should remain as is unless you know what to change
Celery config - these settings are for python celery Should remain as is unless you know what to change
S3 configuration Should remain as is unless you know what to change
Settings to connect to the Bucket from which we are migrating data
AWS_MIGRATION_BUCKET_NAME = env.get('AWS_MIGRATION_BUCKET_NAME', '') Name of bucket to move data to AWS_MIGRATION_ACCESS_KEY_ID = env.get('AWS_MIGRATION_ACCESS_KEY_ID', '') Access key for the S3 user AWS_MIGRATION_SECRET_ACCESS_KEY = env.get('AWS_MIGRATION_SECRET_ACCESS_KEY', '') Secret Key for S3 user