Skip to content

Commit 31870a7

Browse files
committed
docs: Update security policy layout preferences
1 parent 839df65 commit 31870a7

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

SECURITY.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,19 @@ We take the security of your private career data, API credentials, and applicati
44

55
---
66

7-
## Public Repository Security Rules
7+
## Public Repository Security Rules
88

99
To protect your personal data, never share or commit:
10-
Your local `.env` file (contains LLM API keys and secrets).
11-
Your local SQLite database `db.sqlite3` (contains candidate resumes, logs, and profile info).
12-
Exported JSON profile data.
13-
Uploaded resumes or generated application drafts (`tmp_uploads/` or `media/browser_sessions/`).
10+
- Your local `.env` file (contains LLM API keys and secrets).
11+
- Your local SQLite database `db.sqlite3` (contains candidate resumes, logs, and profile info).
12+
- Exported JSON profile data.
13+
- Uploaded resumes or generated application drafts (`tmp_uploads/` or `media/browser_sessions/`).
1414

1515
*If you accidentally commit any secrets or API keys, rotate them immediately!*
1616

1717
---
1818

19-
## Supported Versions
19+
## Supported Versions
2020

2121
Security updates are actively applied to the following versions:
2222

@@ -27,7 +27,7 @@ Security updates are actively applied to the following versions:
2727

2828
---
2929

30-
## How to Report a Security Vulnerability
30+
## How to Report a Security Vulnerability
3131

3232
If you discover a security bug or potential vulnerability in **JobScout-AI**, please **do not open a public GitHub issue**. Doing so exposes users to risk before a patch can be developed.
3333

@@ -41,15 +41,15 @@ Alternatively, if the private advisory flow is unavailable, contact the primary
4141

4242
---
4343

44-
## Secure Deployment Checklist
44+
## Secure Deployment Checklist
4545

4646
Before exposing a JobScout-AI server over a local area network (LAN) or hosting it on a VPS:
47-
Set `DJANGO_DEBUG=false` in your `.env`.
48-
Generate a secure, 50+ character `DJANGO_SECRET_KEY` using `python generate_keys.py`.
49-
Set `FIELD_ENCRYPTION_KEY` to encrypt API keys stored in the database.
50-
Restrict `DJANGO_ALLOWED_HOSTS` and `CSRF_TRUSTED_ORIGINS` to trusted domains only.
51-
Enable HTTPS and secure cookies.
52-
Verify your setup by running the deployment security checks:
47+
1. Set `DJANGO_DEBUG=false` in your `.env`.
48+
2. Generate a secure, 50+ character `DJANGO_SECRET_KEY` using `python generate_keys.py`.
49+
3. Set `FIELD_ENCRYPTION_KEY` to encrypt API keys stored in the database.
50+
4. Restrict `DJANGO_ALLOWED_HOSTS` and `CSRF_TRUSTED_ORIGINS` to trusted domains only.
51+
5. Enable HTTPS and secure cookies.
52+
6. Verify your setup by running the deployment security checks:
5353
```bash
5454
python manage.py check --deploy
5555
```

0 commit comments

Comments
 (0)