Skip to content

env: add required and optional info #102

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

Merged
merged 1 commit into from
Sep 2, 2023
Merged

env: add required and optional info #102

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 7 additions & 7 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WALLET
# WALLET [Required]
# ------
# Either a private key
WALLET_PRIVATE_KEY=<your_admin_wallet_private_key>
Expand All @@ -8,13 +8,13 @@ AWS_SECRET_ACCESS_KEY=<your_aws_secret_access_key>
AWS_KMS_KEY_ID=<your_aws_kms_key_id>
AWS_REGION=<your_aws_region>

# THIRDWEB SDK SECRET KEY
# THIRDWEB SDK SECRET KEY [Required]
# -----------------------
# Obtain an Secret Key from thirdweb.com/dashboard
# this enables you to use the default RPCs and extra features
THIRDWEB_SDK_SECRET_KEY=<your_thirdweb_sdk_secret_key>

# DATABASE OPTIONS
# DATABASE OPTIONS [Required]
# ----------------
POSTGRES_HOST=localhost
POSTGRES_DATABASE_NAME=postgres
Expand All @@ -23,13 +23,13 @@ POSTGRES_PASSWORD=postgres
POSTGRES_PORT=5432
POSTGRES_USE_SSL=false

# SERVING OPTIONS
# SERVING OPTIONS [Optional]
# ---------------
PORT=3005
HOST=localhost
OPENAPI_BASE_ORIGIN=http://localhost:3005

# CONFIGURATION OPTIONS
# CONFIGURATION OPTIONS [Optional]
# ----------------------
# the number of transactions to queue for before starting processing
MIN_TRANSACTION_TO_PROCESS=1
Expand All @@ -40,7 +40,7 @@ TRANSACTIONS_TO_BATCH=10
# See example config file: chain-overrides.example.json
CHAIN_OVERRIDES=<path_or_url_to_file>

# CORS OPTIONS
# CORS OPTIONS [Optional]
# ------------
# Configures the Access-Control-Allow-Origin CORS header. Defaults to * (Allow All)
# The value of origin could be of different types:
Expand All @@ -55,7 +55,7 @@ CHAIN_OVERRIDES=<path_or_url_to_file>
ACCESS_CONTROL_ALLOW_ORIGIN=*


# benchmark vars
# benchmark vars [Optional]
BENCHMARK_HOST='http://localhost:3005'
BENCHMARK_URL_PATH='/contract/mumbai/0xc8be6265C06aC376876b4F62670adB3c4d72EABA/write'
BENCHMARK_POST_BODY='{
Expand Down