.env.example

# duplicate this file, rename it as .env, and tailor to your local environment

# [REQUIRED]
#
# this should be the _id of "your" provider in the database (i.e. the providerId
#  to send to the smart contract that designates CodexRecords that have metadata
#  retrievable via your API instance)
#
# if you don't have a provider record in the database, send a POST request to
#  /admin/provider (see: src/routes/admin/provider/create.js)
METADATA_PROVIDER_ID=

# [REQUIRED]
#
# this is used to sign & verify JSON Web Tokens, can be any string you want
JWT_SECRET=

# [REQUIRED]
#
# this is the account used to send transactions on behalf of the API (e.g.
#  faucet token transfers)
#
# for local development, grab the private key of an account generated by ganache
SIGNER_PRIVATE_KEY=

# [REQUIRED]
#
# DB URI for Ethereum Event Listener service
# for local development with default MongoDB port, leave unchanged
# NOTE: this must match the MONGODB_URI you have set in the EEL repository
EEL_MONGODB_URI=mongodb://localhost:27017/eel

# [REQUIRED]
#
# DB URI for this project
# for local development with default MongoDB port, leave unchanged
CODEX_REGISTRY_MONGODB_URI=mongodb://localhost:27017/codex-registry

# [REQUIRED]
#
# these define the set of contracts this project will load from the
#  @codex-protocol/ethereum-service package
#
# see: https://github.com/codex-protocol/npm.ethereum-service
#
# for local development with default Ganache port, leave unchanged
ETHEREUM_RPC_URL=http://localhost:7545
ETHEREUM_NETWORK_ID=5777

# [REQUIRED]
#
# Redis is required in a multi-instance environment (for example cluster mode
#  via PM2)
#
# Redis isn't really necessary for development, but at the moment it's required
#  to run the application, so a Redis instance must be specified here
#
# for local development with default Redis port, leave unchanged
REDIS_HOST=localhost
REDIS_PORT=6379

# [REQUIRED]
#
# These dicate where files associated with Codex Records are stored
#
# AWS_S3_URI_PREFIX will depend on your AWS_REGION, e.g:
#
# AWS_REGION=us-east-1
# AWS_S3_URI_PREFIX=https://s3.amazonaws.com
#
# or
#
# AWS_REGION=us-west-2
# AWS_S3_URI_PREFIX=https://s3-us-west-2.amazonaws.com
#
AWS_S3_BUCKET=
AWS_REGION=us-east-1
AWS_S3_URI_PREFIX=https://s3.amazonaws.com

# [OPTIONAL]
# if you'd like to use Sentry for error reporting, the DSN may be specified here
#
# for local development, you probably won't use this
# SENTRY_DSN=