Skip to content

Add .env.sample #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pbrudny wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add .env.sample #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1b685b
Rename README, add .env.sample
pbrudny Sep 2, 2025
c39207b
Update README
pbrudny Sep 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .env.sample
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# App
PORT=5000
FLASK_ENV=development
X_API_KEY=choose-a-strong-secret

# OpenAI
OPENAI_API_KEY=sk-...
EMBEDDING_MODEL=text-embedding-3-small
# OPTIONAL (if you belong to multiple orgs)
# OPENAI_ORG=org_XXXXXX

# Database (pgvector must be enabled in this DB)
N8N_DB_NAME=ragdb
N8N_DB_USER=rag
N8N_DB_PASSWORD=ragpass
N8N_DB_HOST=localhost
N8N_DB_PORT=5432

# Google Drive ingestion
GOOGLE_FOLDER_ID=your-drive-folder-id
GOOGLE_CREDENTIALS_FILE=./google-credentials.json
POLL_INTERVAL_SECONDS=60
2 changes: 0 additions & 2 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ __pycache__/

# secrets
.env
.env.*
google-credentials.json
**/google-credentials.json

Expand All @@ -17,6 +16,5 @@ Thumbs.db
.vscode/
.idea/
.env
.env.*
google-credentials.json
**/google-credentials.json
6 changes: 6 additions & 0 deletions Readme.md → README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,12 @@ pip install -r requirements.txt

Use the [template](#env-template) below.

or copy the sample to `.env`

```bash
cp .env.sample .env
```

### 3) Initialize DB schema (tables + `match_documents`)

```bash
Expand Down