Environment
Your .env file configuration reference.
Your environment values should be set using the pattern
VARIABLE=value
on new lines each. Notice that there is no space between VARIABLE
, =
and value
Do NOT add space between values, and if you absolute need to, you have to put them in quotes as such
VARIABLE="really long value"
Heads Up! Don't change a variable that we have not explicitly instructed you to change in this document, unless of course, you know what you are doing.
The categories marked with asterisk (*) are required for Cryptitan to successfully build and start. If you skip any one of these, Cryptitan will NOT START!
If any of the variable stated here is not predefined in the environment file, you should write it in a new line at the end of the file.
APP_NAME
set your application nameAPP_URL
set your domain, e.g. APP_URL=https://example.com
CERTBOT_EMAIL
set your official email addressThe database is automatically built within the container of Cryptitan and it is only accessible by Cryptitan itself, so any database credential set is inherently safe.
Database credential must only be set ONCE and not changed afterwards. Because the database is only built one time. If you change the credential, Cryptitan will no longer be able to connect to it.
DB_USERNAME
set your database username (any random value will work)DB_PASSWORD
set your database password (any random value will work)MAIL_HOST
set your SMTP host.MAIL_PORT
set your SMTP port.MAIL_USERNAME
set your SMTP usernameMAIL_PASSWORD
set your SMTP passwordMAIL_ENCRYPTION
set to "tls" for sending of encrypted mailsMAIL_FROM_ADDRESS
set your email "from" address, it could be something like [email protected]. This usually requires domain verification on your SMTP server.MAIL_FROM_NAME
set your email "from" name. You can leave it as "${APP_NAME}"
to set your APP_NAMEBITGO_ENV
sets your BitGo to test or prod environment.Don't change your BitGo environment after setup! Wallet balances of users are always retained, and you don't want a user's account that was credited on a testnet environment to be able to withdraw the same value on a production environment. You typically want to have two installations of Cryptitan for the two environment. One installation will be for testing purpose, while the other is for production.
RECAPTCHA_SIZE
set to normal
or invisible
You don't need to obtain API keys from Pusher because Cryptitan hosts its own WebSocket service. You should leave the environment values as they are.
A redis server is automatically built with Cryptitan's network and it is only accessible to cryptitan, which makes it inherently safe. Leave the redis information as it is and you are good to go!
GEOIP_SERVICE
set your maxmind service. This can be one of maxmind_api
or maxmind_database
Don't change Ethereum Network after setup! Wallet balances of users are always retained, and you don't want a user's account which was credited on a testnet environment to be able to withdraw the same value on a production environment. You typically want to have two installations of Cryptitan for the two environment. One installation will be for testing purpose, while the other is for production.
BINANCE_WS
(required) sets the destination WebSocket node URL for Binance network. We recommend: ChainstackDon't change Binance Network after setup! Wallet balances of users are always retained, and you don't want a user's account which was credited on a testnet environment to be able to withdraw the same value on a production environment. You typically want to have two installations of Cryptitan for the two environment. One installation will be for testing purpose, while the other is for production.
The value of your
MONGODB_URL
should be wrapped in quotes.This is where all encrypted private keys of the system would be stored. We strongly recommend you properly set up your mongodb atlas with regular backups, and you should NEVER attempt to alter the content of the database directly. We, the cryptitan team, WILL NOT be responsible for any form of data loss or corruption.
SMS_PROVIDER
set your SMS provider, this could be one of vonage
, twilio
, africastalking
, sns
. Each requires its own specific environment values, refer to their section.VONAGE_SMS_FROM
set your vonage phone numberTWILIO_AUTH_TOKEN
set your Twilio auth tokenTWILIO_ACCOUNT_SID
set your Twilio account SIDTWILIO_FROM
set your Twilio numberTWILIO_SMS_SERVICE_SID
set your Twilio sms service SIDTWILIO_ALPHA_SENDER
(optional) set your Twilio sender nameTWILIO_SMS_SERVICE_SID
(optional) set your sms service IDYou need to Register and then go to your sandbox app Go To SandBox App, Click on settings Within this page, you will generate your
Username and key
.Remember to add your Sender ID that you will be using to send the messages.
AT_USERNAME
set your AfricasTalking usernameAT_KEY
set your AfricasTalking secret keyAT_FROM
set your AfricasTalking Sender IDPAYPAL_CLIENT_ENV
set to either sandbox
or live
PAYPAL_CLIENT_ID
set your PayPal client IDPAYPAL_CLIENT_SECRET
set your PayPal client secretAfter subsequent changes to the environment file in the future. Remember to rebuild Cryptitan with:
./cryptitan recreate
STRIPE_ENABLE
set to either true
or false
STRIPE_KEY
set your Stripe secret key herePAYU_ENABLE
set to either true
or false
PAYU_CLIENT_ENV
set to either secure
or sandbox
for production or test environment.PAYU_CLIENT_ID
set your OAuth Client IDPAYU_CLIENT_SECRET
set your OAuth Client SecretPAYU_CURRENCY
set your PayU account currencyPAYSTACK_ENABLE
set to either true
or false
PAYSTACK_CLIENT_SECRET
set your Secret Key hereMOLLIE_ENABLE
set to either true
or false
MOLLIE_CLIENT_KEY
set your API key hereLast modified 6mo ago