Spaces:
Running
Running
Richard Fan
commited on
Commit
·
42fdd24
1
Parent(s):
44ce5f6
more warnings
Browse files- .env.template +5 -7
- README.md +5 -5
.env.template
CHANGED
@@ -2,13 +2,11 @@
|
|
2 |
|
3 |
|
4 |
##################################################################################################
|
5 |
-
#
|
6 |
-
# Do not edit and commit your .env.template with your personal keys, it might reveal you API keys
|
7 |
-
# copy this file to .env and only then edit your .env file not this file
|
8 |
##################################################################################################
|
9 |
-
OPENAI_API_KEY=your_api_key
|
10 |
|
11 |
## EMAIL SETTINGS
|
12 |
-
SENDGRID_API_KEY=your_api_key
|
13 |
-
FROM_EMAIL=your_email
|
14 |
-
TO_EMAIL=your_email
|
|
|
2 |
|
3 |
|
4 |
##################################################################################################
|
5 |
+
# DO NOT COMMIT YOUR API KEYS OR EMAIL ADDRESS TO YOUR REPOSITORY
|
|
|
|
|
6 |
##################################################################################################
|
7 |
+
OPENAI_API_KEY=your_api_key # DO NOT COMMIT ANY FILE WITH THIS KEY SET
|
8 |
|
9 |
## EMAIL SETTINGS
|
10 |
+
SENDGRID_API_KEY=your_api_key # DO NOT COMMIT ANY FILE WITH THIS KEY SET
|
11 |
+
FROM_EMAIL=your_email # DO NOT COMMIT ANY FILE WITH THIS KEY SET
|
12 |
+
TO_EMAIL=your_email # DO NOT COMMIT ANY FILE WITH THIS KEY SET
|
README.md
CHANGED
@@ -83,12 +83,12 @@ To locally run the same UI as the Huggign Face space:
|
|
83 |
|
84 |
1. Install the requirements in `src/requirements.txt` as well as `gradio`.
|
85 |
2. Run `python src/app.py` and go to the local URL. From there you will be able to preview the papers from today, as well as the generated digests.
|
86 |
-
3. If you want to
|
87 |
-
-
|
88 |
-
- The .env file is one of the files in .gitignore,
|
89 |
-
-
|
90 |
|
91 |
-
> **WARNING:**
|
92 |
|
93 |
## ✅ Roadmap
|
94 |
|
|
|
83 |
|
84 |
1. Install the requirements in `src/requirements.txt` as well as `gradio`.
|
85 |
2. Run `python src/app.py` and go to the local URL. From there you will be able to preview the papers from today, as well as the generated digests.
|
86 |
+
3. If you want to use a `.env` file for your secrets, you can copy `.env.template` to `.env` and then set the environment variables in `.env`.
|
87 |
+
- Note: These file may be hidden by default in some operating systems due to the dot prefix.
|
88 |
+
- The .env file is one of the files in .gitignore, so git does not track it and it will not be uploaded to the repository.
|
89 |
+
- Do not edit the original `.env.template` with your keys or your email address, since `.template.env` is tracked by git and editing it might cause you to commit your secrets.
|
90 |
|
91 |
+
> **WARNING:** Do not edit and commit your `.env.template` with your personal keys or email address! Doing so may expose these to the world!
|
92 |
|
93 |
## ✅ Roadmap
|
94 |
|