Skip to content

Commit d6bfe8a

Browse files
committed
updates .env file documentation
Signed-off-by: Nell Shamrell <[email protected]>
1 parent 70c62fc commit d6bfe8a

File tree

2 files changed

+27
-4
lines changed

2 files changed

+27
-4
lines changed

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,10 @@ development environment for Clearly Defined including:
55
* [website](https://github.com/clearlydefined/website)
66
* [service](https://github.com/clearlydefined/service)
77
* [crawler](https://github.com/clearlydefined/crawler)
8+
* harvest store (mounted as a volume in the service container)
89
* definitions and curations mongo DB databases
910
* queues
1011

11-
We do this through running the various services in Docker.
12-
1312
We do this through [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/)
1413

1514
## Pre-reqs
@@ -100,11 +99,30 @@ CURATION_GITHUB_OWNER="clearlydefined"
10099
CURATION_GITHUB_REPO="curated-data-dev"
101100
CURATION_GITHUB_TOKEN="<Your GitHub Personal Access Token>
102101
102+
103+
# Curation Store Info
104+
CURATION_MONGO_CONNECTION_STRING="mongodb://clearlydefined_mongo_db"
105+
CURATION_MONGO_DB_NAME="clearlydefined"
106+
CURATION_MONGO_COLLECTION_NAME="curations"
107+
CURATION_PROVIDER="github"
108+
CURATION_STORE_PROVIDER="mongo"
109+
110+
# Definition Store Info
103111
DEFINITION_STORE_PROVIDER="mongo"
104112
DEFINITION_MONGO_CONNECTION_STRING="mongodb://clearlydefined_mongo_db"
105113
DEFINITION_MONGO_DB_NAME="clearlydefined"
106114
DEFINITION_MONGO_COLLECTION_NAME="definitions-paged"
107115
116+
# Harvest Store Info
117+
HARVEST_STORE_PROVIDER="file"
118+
119+
# Note - this is mounted as a volume
120+
# into the container for the
121+
# clearly defined service
122+
# see docker-compose.yml for more details
123+
FILE_STORE_LOCATION="/tmp/harvested_data"
124+
125+
# Crawler Info
108126
CRAWLER_GITHUB_TOKEN="<Your GitHub Personal Access Token>"
109127
```
110128

sample_env

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,11 @@ DEFINITION_MONGO_COLLECTION_NAME="definitions-paged"
2020
# Harvest Store Info
2121
HARVEST_STORE_PROVIDER="file"
2222

23-
# Crawler Info
24-
CRAWLER_GITHUB_TOKEN="<your GitHub token>"
23+
# Note - this is mounted as a volume
24+
# into the container for the
25+
# clearly defined service
26+
# see docker-compose.yml for more details
27+
FILE_STORE_LOCATION="/tmp/harvested_data"
2528

29+
# Crawler Info
30+
CRAWLER_GITHUB_TOKEN="<your GitHub token>"

0 commit comments

Comments
 (0)