From 4ef9337d018da418488512ea13a0319bae354fb6 Mon Sep 17 00:00:00 2001 From: Marcus Christie Date: Thu, 13 Jan 2022 16:39:19 -0500 Subject: [PATCH] Clarify how to get started with settings_local.py --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ec6692e96..d0623edce 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,14 @@ information on how to install yarn. 2. Create a local settings file. - - You can either copy `django_airavata/settings_local.py.sample` to + - Option 1 (**recommended**). The best way to get a local settings file is + to download one from an existing Airavata Django Portal instance. If you + have Admin access, you can log in, go to _Settings_ and then _Developer + Console_ (/admin/developers) and download a `settings_local.py` file for + local development. Save it to the `django_airavata/` directory. + + - Option 2. Otherwise, if you know the hostname and ports of an Airavata + deployment, you can copy `django_airavata/settings_local.py.sample` to `django_airavata/settings_local.py` and edit the contents to match your Keycloak and Airavata server deployments. @@ -54,11 +61,6 @@ information on how to install yarn. cp django_airavata/settings_local.py.sample django_airavata/settings_local.py ``` - - Or, if you have Admin access to an Airavata Django Portal instance, you - can log in, go to _Settings_ and then _Developer Console_ - (/admin/developers) and download a `settings_local.py` file for local - development. Save it to the `django_airavata/` directory. - 3. Run Django migrations ```