Skip to content

Commit 789e1aa

Browse files
authored
[CHORE] Format and update .env.example (#500)
1 parent 101a752 commit 789e1aa

1 file changed

Lines changed: 65 additions & 41 deletions

File tree

.env.example

Lines changed: 65 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,78 @@
11
# This is an example of what your env file should look like.
2-
# You can copy this file and rename it to .env and fill in the values.
3-
VITE_PROJECT_HOSTNAME=pic-sure.org
4-
VITE_RESOURCE_HPDS=some-uuid
5-
VITE_RESOURCE_OPEN_HPDS=some-uuid
6-
VITE_RESOURCE_BASE_QUERY=some-uuid
7-
VITE_RESOURCE_VIZ=some-uuid
8-
VITE_RESOURCE_APPLICATION=some-uuid
9-
VITE_RESOURCE_SEARCH=some-uuid
10-
VITE_AUTH0_TENANT=avillachlab
2+
# You can copy this file and rename it to .env for local use and httpd.env for using our docker configuration.
3+
# Please refer to our documentation on Gitbook: https://pic-sure.gitbook.io/pic-sure-developer-guide/configuring-pic-sure/pic-sure-frontend-configuration
4+
5+
### Application (optional)
6+
VITE_APPLICATION_NAME="PIC-SURE"
7+
VITE_PROJECT_HOSTNAME=picsure.example.com
8+
VITE_ORIGIN=https://picsure.example.com/
119

12-
# Customization
10+
### UI
1311
# Here you can customize the logo and dot colors on the login page for your project
1412
# To fully change the theme add a new theme to src/styles/theme.css and change the
1513
# data-theme= attribute in the body tag of the main html file, app.html
1614
# You can list 0, 3, or 5 colors in the VITE_DOTS_COLORS_CLASS array
17-
VITE_LOGO=./path/to/logo.svg
18-
VITE_DOTS_COLORS_CLASS='["--color-primary-500", "--color-error-500", "--color-tertiary-500"]'
15+
VITE_LOGO=/app-logo.png #/path/to/logo.svg
16+
VITE_DOTS_COLORS_CLASS='["--color-primary-500", "--color-error-500", "--color-surface-400"]'
1917

20-
# Features
21-
VITE_OPEN=true
22-
VITE_ALLOW_EXPORT=true
23-
VITE_ALLOW_DOWNLOAD=true
24-
VITE_ALLOW_EXPORT_ENABLED=true
18+
### Resources (only HPDS is required)
19+
VITE_RESOURCE_HPDS=12345678-9000-abcd-0000-000000000000
20+
VITE_RESOURCE_OPEN_HPDS=
21+
VITE_RESOURCE_BASE_QUERY=
22+
VITE_RESOURCE_QUERY_ID_GEN=
23+
VITE_RESOURCE_VIZ=
24+
25+
### Pages
26+
VITE_OPEN=false
27+
VITE_DASHBOARD=false
28+
VITE_DISCOVER=false
29+
VITE_ANALYZE_API=true
30+
31+
### Features
32+
VITE_ENABLE_TOS=false
33+
VITE_ALLOW_EXPORT=true #Page
34+
VITE_ALLOW_EXPORT_ENABLED=true #Search Result Icon
35+
VITE_DASHBOARD_DRAWER=false
36+
VITE_VARIANT_EXPLORER=true
2537
VITE_ENABLE_HIERARCHY=true
26-
VITE_DATA_REQUESTS=true
2738
VITE_DIST_EXPLORER=true
28-
VITE_ENABLE_SNP_QUERY=true
39+
#VITE_DIST_EXPLORER_GRAPH_COLORS=["#328FFF", "#675AFF", "#FFBC35"]
40+
# Export
41+
VITE_ALLOW_DOWNLOAD=true
42+
VITE_CONFIRM_DOWNLOAD=true
43+
VITE_DOWNLOAD_AS_PFB=true
44+
VITE_MAX_DATA_POINTS_FOR_EXPORT=1000000
45+
VITE_ENABLE_TERRA_EXPORT=false
46+
VITE_ENABLE_SAMPLE_ID_CHECKBOX=false
47+
VITE_SHOW_TREE_STEP=true
48+
# Genomic
2949
VITE_ENABLE_GENE_QUERY=true
30-
VITE_VARIANT_EXPLORER=true
50+
VITE_ENABLE_SNP_QUERY=true
51+
# Study Auth
52+
VITE_REQUIRE_CONSENTS=false
53+
VITE_USE_QUERY_TEMPLATE=false
54+
VITE_MANUAL_ROLE=false
55+
# Tour
3156
VITE_EXPLORE_TOUR=true
3257
VITE_EXPLORE_TOUR_SEARCH_TERM=age
33-
VITE_REQUIRE_CONSENTS=true
34-
VITE_USE_QUERY_TEMPLATE=true
35-
VITE_ANALYZE_API=true
58+
VITE_AUTH_TOUR_NAME=NHANES-Auth
59+
VITE_OPEN_TOUR_NAME=NHANES-Auth
60+
#Variant Explorer Settings
61+
VITE_VARIANT_EXPLORER_TYPE=aggregate
62+
VITE_VARIANT_EXPLORER_MAX_COUNT=10000
63+
VITE_VARIANT_EXPLORER_EXCLUDE_COLUMNS= # As an array
64+
65+
### Federation (GIC)
66+
## Pages
67+
VITE_COLLABORATE=false
3668
VITE_ANALYZE_ANALYSIS=false
37-
VITE_DISCOVER=true
38-
VITE_COLLABORATE=true
39-
VITE_DASHBOARD=true
40-
VITE_DASHBOARD_DRAWER=true
41-
VITE_ENABLE_SAMPLE_ID_CHECKBOX=true
69+
VITE_DATA_REQUESTS=false
70+
## Features
4271
VITE_ENABLE_COHORT_DETAILS=false
4372
VITE_FEDERATED=false
73+
VITE_ENABLE_REDCAP_EXPORT=false
4474

75+
### Auth Providers
4576
# VITE_AUTH_PROVIDER_MODULE is the prefix for any authorization providers you want to use.
4677
# We currently support 3 types of authorization providers: AUTH0, Gen3 FENCE, and RAS.
4778
# You can add as many authorization providers as you want by adding more VITE_AUTH_PROVIDER_MODULE_ variables.
@@ -50,6 +81,9 @@ VITE_FEDERATED=false
5081
# VITE_AUTH_PROVIDER_MODULE_GOOGLE_ALT is an optional field that can be used to specify if the provider should be displayed as an alternative login option.
5182
# The pattern for adding authorization providers is as follows:
5283
# VITE_AUTH_PROVIDER_MODULE_<PROVIDER_NAME>_<FIELD>=<VALUE>
84+
# See https://pic-sure.gitbook.io/pic-sure-developer-guide/configuring-pic-sure/pic-sure-frontend-configuration#login
85+
VITE_AUTH0_TENANT=avillachlab
86+
## Auth0 example
5387
VITE_AUTH_PROVIDER_MODULE_GOOGLE=true
5488
VITE_AUTH_PROVIDER_MODULE_GOOGLE_TYPE=AUTH0
5589
VITE_AUTH_PROVIDER_MODULE_GOOGLE_CLIENTID=12345ABCD
@@ -58,16 +92,6 @@ VITE_AUTH_PROVIDER_MODULE_GOOGLE_DESCRIPTION="Login with Auth0"
5892
VITE_AUTH_PROVIDER_MODULE_GOOGLE_HELPTEXT='Login with your <a href="https://google.com">Google</a> account'
5993
VITE_AUTH_PROVIDER_MODULE_GOOGLE_ALT=false
6094

61-
# VITE_EXPLORE_TOUR_SEARCH_TERM=age
62-
# VITE_DIST_EXPLORER_GRAPH_COLORS=["#328FFF", "#675AFF", "#FFBC35"]
63-
64-
# Variant Explorer Settings
65-
# VITE_VARIANT_EXPLORER_TYPE=aggregate
66-
# VITE_VARIANT_EXPLORER_MAX_COUNT=10000
67-
# VITE_VARIANT_EXPLORER_EXCLUDE_COLUMNS=["AC","AN"]
68-
69-
VITE_GOOGLE_ANALYTICS_ID=someid
70-
VITE_GOOGLE_TAG_MANAGER_ID=someid
71-
72-
VITE_AUTH_TOUR_NAME=NHANES-Auth
73-
VITE_OPEN_TOUR_NAME=BDC-Open
95+
### Analytics (Leave blank to disable)
96+
VITE_GOOGLE_ANALYTICS_ID=
97+
VITE_GOOGLE_TAG_MANAGER_ID=

0 commit comments

Comments
 (0)