Skip to content

Commit

Permalink
README for secrets (#18)
Browse files Browse the repository at this point in the history
  • Loading branch information
ssbdragonfly authored Jan 24, 2025
1 parent 78595d5 commit b47a521
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions portal/secrets/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Portal Secret Files

This directory should contain secret configuration files required by the portal. These files should never be committed to version control.

## Required Files

### Email Whitelists

1. `user_email_whitelist.txt`
- One email per line
- Controls who can access the portal
- Required in production unless explicitly disabled

2. `team_email_whitelist.txt`
- One email per line
- Identifies HackTJ team members
- Grants elevated permissions

3. `admin_email_whitelist.txt`
- One email per line
- Designates administrative users
- Highest level of access

### Format

Each whitelist file should contain one email address per line:

```
user1@example.com
user2@example.com
user3@example.com
```

## Other Secret Files

- `secret.py`: Django settings containing sensitive values
- Copy from `portal/settings/dev.secret.py`
- Add Google OAuth2 credentials
- Update `SECRET_KEY`
- Configure other sensitive settings

0 comments on commit b47a521

Please sign in to comment.