Skip to content

Commit

Permalink
more updates
Browse files Browse the repository at this point in the history
  • Loading branch information
Aaron Kanzer authored and Aaron Kanzer committed Apr 18, 2024
1 parent 71c92b2 commit 9c2ec5c
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 4 deletions.
7 changes: 5 additions & 2 deletions docs/61_dandi_authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Setting up your GitHub OAuth Account

Please follow the steps in [Initialize Vendors - Github](../60_initialize_vendors/#github) to get started.
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).
Expand Down Expand Up @@ -52,6 +52,9 @@ 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


26 changes: 24 additions & 2 deletions docs/64_dandi_archive.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,35 @@
# Work In Progress

## Understanding the concept of the Procfile for Heroku

This step assumes that you have completed all steps in:
[Initialize Vendors](../60_initialize_vendors)
[DANDI Infrastructure](../63_dandi_infrastructure)

Heroku initializes compute on servers (known as `dynos` in Heroku land). Each `dyno` that you have runs a process.
Which process, the resources allocated to that process, and how that process is run, is defined in a `Procfile`

DANDI Archive defines a [Procfile](https://github.com/dandi/dandi-archive/blob/master/Procfile). In this `Procfile`,
you'll see several entries:

`release`: a command that is run each time a new version of DANDI API is pushed to Heroku
`web`: runs `gunicorn`, a persistent server that handles HTTP requests for the DANDI API
`worker`: a worker process that runs `celery` behind-the-scenes. `celery` handles tasks that would otherwise cause the API to timeout
`checksum-worker`: another worker, also using `celery`, that specifically calculates if a new file pushed to DANDI Archive is new/updated, and determines what exactly has been changed
`analytics-worker`: another `celery` worker that handles all tasks related to processing of S3-related logs

This `Procfile` shouldn't need to be changed or reconfigured much for a DANDI-clone; however, it is important to note so that one may understand how the Archive is working

## Understanding metrics and logging via Heroku

## Configuring email alerts via Heroku

## Creating a Django "superuser" (Admin) Account

## Updating Allowed Hosts

## Referencing Authentication credentials from migrations

## Setting up a "Superuser" (Admin) Account

## Deployment Strategy via Heroku's Procfile

## Approval of Users
Expand Down

0 comments on commit 9c2ec5c

Please sign in to comment.