diff --git a/docs/61_dandi_authentication.md b/docs/61_dandi_authentication.md index efae4062..f3b0e841 100644 --- a/docs/61_dandi_authentication.md +++ b/docs/61_dandi_authentication.md @@ -2,6 +2,56 @@ ## Setting up your GitHub OAuth Account +Please follow the steps in [Initialize Vendors - Github](../60_initialize_vendors/#github) to get started. + +For the next steps in setting up authentication, you'll want to record the values +created during [Obtaining your Oauth App creds](..60_initialize_vendors/#obtaining-your-oauth-app-credentials). + +## Creating "Sites" and "Social App" in DANDI Archive Admin Panel + +*In order to complete this step, you will need to have deployed an initial DANDI Archive API -- see here for more details [Creating the DANDI Archive API](../64_dandi_archive) + +First, sign in via the Django admin panel with your credentials created via the [Creating an admin user account for the DANDI Archive API step](../64_dandi_archive/#creating-a-django-superuser-admin-account) + +The Django Admin panel should be located at: `
+ +

+ +Next, you'll want to proceed to the `Sites' tab -- create 2 sites, one for your UI, and another for your API domain + +

+ +

+ +Next, you'll want to proceed to the `Social applications` tab, located on the left side panel. Once in this panel, you'll need to click +`Add Social Application` in the top right corner + +

+ +

+ +Once in this panel, you'll want to create a `Social Application` object with: + +• The Provider as `GitHub` +• The client ID as your GitHub OAuth client ID +• The client secret as your GitHub OAuth client secret +• Two `Sites` objects -- these objects you should have created a few steps prior + +After creating this object, you are all set in the Django Admin panel for now. + +## Populating appropriate values for the frontend to handle authentication + ## Configuring Migrations for Initial Auth Setup ## Session Management \ No newline at end of file diff --git a/docs/64_dandi_archive.md b/docs/64_dandi_archive.md index 3ddee3fd..2e32c393 100644 --- a/docs/64_dandi_archive.md +++ b/docs/64_dandi_archive.md @@ -1,5 +1,7 @@ # Work In Progress +## Creating a Django "superuser" (Admin) Account + ## Updating Allowed Hosts ## Referencing Authentication credentials from migrations diff --git a/docs/img/admin_panel.png b/docs/img/admin_panel.png new file mode 100644 index 00000000..6d91dc31 Binary files /dev/null and b/docs/img/admin_panel.png differ diff --git a/docs/img/githuh_social_app_values.png b/docs/img/githuh_social_app_values.png new file mode 100644 index 00000000..25155b2a Binary files /dev/null and b/docs/img/githuh_social_app_values.png differ diff --git a/docs/img/site_admin.png b/docs/img/site_admin.png new file mode 100644 index 00000000..2a261d96 Binary files /dev/null and b/docs/img/site_admin.png differ diff --git a/docs/img/social_app_panel.png b/docs/img/social_app_panel.png new file mode 100644 index 00000000..319660fa Binary files /dev/null and b/docs/img/social_app_panel.png differ