diff --git a/.env_sample b/.env_sample index 64decff4d..c14c29212 100644 --- a/.env_sample +++ b/.env_sample @@ -1,59 +1,59 @@ # Development options -export SKIP_SERVICEWORKERS="true" +SKIP_SERVICEWORKERS="true" # App core values -export APP_DOMAIN="localhost:3000" -export APP_PROTOCOL="http://" -export FOREM_OWNER_SECRET="secret" +APP_DOMAIN="localhost:3000" +APP_PROTOCOL="http://" +FOREM_OWNER_SECRET="secret" # Community Related Variables -export COMMUNITY_NAME="DEV(local)" +COMMUNITY_NAME="DEV(local)" # Email related variables -export DEFAULT_EMAIL="yo@dev.to" +DEFAULT_EMAIL="yo@dev.to" # Service timeout length -export RACK_TIMEOUT_WAIT_TIMEOUT=100_000 -export RACK_TIMEOUT_SERVICE_TIMEOUT=100_000 +RACK_TIMEOUT_WAIT_TIMEOUT=100_000 +RACK_TIMEOUT_SERVICE_TIMEOUT=100_000 # Heroku release slug used to bust caches on deploys -export HEROKU_RELEASE_CREATED_AT="" -export HEROKU_SLUG_COMMIT="" +HEROKU_RELEASE_CREATED_AT="" +HEROKU_SLUG_COMMIT="" # Redis caching storage -export REDIS_URL="redis://localhost:6379" +REDIS_URL="redis://localhost:6379" # Redis sessions storage -export REDIS_SESSIONS_URL="redis://localhost:6379" -export SESSION_KEY="_Dev_Community_Session" -export SESSION_EXPIRY_SECONDS=1209600 # two weeks in seconds +REDIS_SESSIONS_URL="redis://localhost:6379" +SESSION_KEY="_Dev_Community_Session" +SESSION_EXPIRY_SECONDS=1209600 # two weeks in seconds # Redis Sidekiq storage -export REDIS_SIDEKIQ_URL="redis://localhost:6379" +REDIS_SIDEKIQ_URL="redis://localhost:6379" # Elasticsearch -export ELASTICSEARCH_URL="http://localhost:9200" +ELASTICSEARCH_URL="http://localhost:9200" # OpenResty -export OPENRESTY_URL="" +OPENRESTY_URL="" # SSL config -export FORCE_SSL_IN_RAILS="not applicable in dev" +FORCE_SSL_IN_RAILS="not applicable in dev" # Postgres DB -export DATABASE_NAME="Forem_development" # Used when creating a db instance `rails db:create` -export DATABASE_URL="postgresql://localhost:5432/$DATABASE_NAME" # This takes precedence over `DATABASE_NAME` if they don't match -export RAILS_MAX_THREADS=5 # Specifies the number of Puma threads -export WEB_CONCURRENCY=2 # Specifies the number of `workers` to boot in clustered mode. -export DATABASE_POOL_SIZE=5 # The number of concurrent connections to Postgres. If unset the value of RAILS_MAX_THREADS will be used in it's place. -export DATABASE_NAME_TEST=Forem_test -export DATABASE_URL_TEST="postgresql://localhost:5432/$DATABASE_NAME_TEST" # Differentiate test db from dev db. Test DB is wiped on each test run. +DATABASE_NAME="Forem_development" # Used when creating a db instance `rails db:create` +DATABASE_URL="postgresql://localhost:5432/$DATABASE_NAME" # This takes precedence over `DATABASE_NAME` if they don't match +RAILS_MAX_THREADS=5 # Specifies the number of Puma threads +WEB_CONCURRENCY=2 # Specifies the number of `workers` to boot in clustered mode. +DATABASE_POOL_SIZE=5 # The number of concurrent connections to Postgres. If unset the value of RAILS_MAX_THREADS will be used in it's place. +DATABASE_NAME_TEST=Forem_test +DATABASE_URL_TEST="postgresql://localhost:5432/$DATABASE_NAME_TEST" # Differentiate test db from dev db. Test DB is wiped on each test run. # Rails -export RAILS_ENV="development" # Set to 'production' when deploying for security and performance. +RAILS_ENV="development" # Set to 'production' when deploying for security and performance. # Node -export NODE_ENV="development" # Set to 'production' when deploying for security and performance. +NODE_ENV="development" # Set to 'production' when deploying for security and performance. ################################################ ######### Optional 3rd Party Services ########## @@ -61,97 +61,97 @@ export NODE_ENV="development" # Set to 'production' when deploying for security # Honeybadger for error tracking # (https://docs.honeybadger.io/lib/ruby/getting-started/introduction.html) -export HONEYBADGER_API_KEY="Optional" -export HONEYBADGER_JS_API_KEY="Optional" +HONEYBADGER_API_KEY="Optional" +HONEYBADGER_JS_API_KEY="Optional" # AWS for images storages -export AWS_ID="Optional" -export AWS_SECRET="Optional" -export AWS_BUCKET_NAME="Optional" -export AWS_UPLOAD_REGION="" +AWS_ID="Optional" +AWS_SECRET="Optional" +AWS_BUCKET_NAME="Optional" +AWS_UPLOAD_REGION="" # AWS for video storage -export AWS_S3_INPUT_BUCKET="Optional" -export AWS_S3_VIDEO_ID="Optional" -export AWS_S3_VIDEO_KEY="Optional" +AWS_S3_INPUT_BUCKET="Optional" +AWS_S3_VIDEO_ID="Optional" +AWS_S3_VIDEO_KEY="Optional" # Buffer for sending to buffer # This is legacy, as Buffer no longer supports this functionality for NEW accounts. # DEV is still using this for now. # (https://buffer.com/developers/api) -export BUFFER_ACCESS_TOKEN="Optional" -export BUFFER_FACEBOOK_ID="Optional" -export BUFFER_LINKEDIN_ID="Optional" -export BUFFER_PROFILE_ID=0 -export BUFFER_TWITTER_ID="Optional" -export BUFFER_LISTINGS_PROFILE="Optional" +BUFFER_ACCESS_TOKEN="Optional" +BUFFER_FACEBOOK_ID="Optional" +BUFFER_LINKEDIN_ID="Optional" +BUFFER_PROFILE_ID=0 +BUFFER_TWITTER_ID="Optional" +BUFFER_LISTINGS_PROFILE="Optional" # Cloudinary for image resizing and cache?? # (https://cloudinary.com/documentation/rails_integration) -export CLOUDINARY_API_KEY="Optional" -export CLOUDINARY_API_SECRET="Optional" -export CLOUDINARY_CLOUD_NAME="Optional" -export CLOUDINARY_SECURE="Optional" +CLOUDINARY_API_KEY="Optional" +CLOUDINARY_API_SECRET="Optional" +CLOUDINARY_CLOUD_NAME="Optional" +CLOUDINARY_SECURE="Optional" # HTML/CSS to Image for generating social preview images # (https://docs.htmlcsstoimage.com/example-code/ruby) -export HCTI_API_USER_ID="Optional" -export HCTI_API_KEY="Optional" +HCTI_API_USER_ID="Optional" +HCTI_API_KEY="Optional" # Fastly for edge caching # (https://docs.fastly.com/api/) -export FASTLY_API_KEY="" -export FASTLY_SERVICE_ID="" +FASTLY_API_KEY="" +FASTLY_SERVICE_ID="" # Honeycomb for monitoring and observability # (https://www.honeycomb.io/) -export HONEYCOMB_API_KEY="" +HONEYCOMB_API_KEY="" # Google analytics # (https://developers.google.com/analytics/devguides/reporting/core/v4) -export GA_TRACKING_ID="Optional" +GA_TRACKING_ID="Optional" # Mailchimp for mails # (https://mailchimp.com/developer/) -export MAILCHIMP_API_KEY="Optional-valid" +MAILCHIMP_API_KEY="Optional-valid" # Pusher for DEV Connect/notfications # (https://pusher.com/docs) -export PUSHER_APP_ID= -export PUSHER_CLUSTER= -export PUSHER_KEY= -export PUSHER_SECRET= -export PUSHER_BEAMS_ID= -export PUSHER_BEAMS_KEY= +PUSHER_APP_ID= +PUSHER_CLUSTER= +PUSHER_KEY= +PUSHER_SECRET= +PUSHER_BEAMS_ID= +PUSHER_BEAMS_KEY= # Google recaptcha (Optional) # (https://developers.google.com/recaptcha/intro) -export RECAPTCHA_SECRET= -export RECAPTCHA_SITE= +RECAPTCHA_SECRET= +RECAPTCHA_SITE= # Slack for customer alerts # (https://api.slack.com/) -export SLACK_CHANNEL="" -export SLACK_DEPLOY_CHANNEL="" -export SLACK_WEBHOOK_URL="" +SLACK_CHANNEL="" +SLACK_DEPLOY_CHANNEL="" +SLACK_WEBHOOK_URL="" # For video calling in DEV Connect # (https://www.twilio.com/docs/video) -export TWILIO_ACCOUNT_SID="Optional" -export TWILIO_VIDEO_API_KEY="Optional" -export TWILIO_VIDEO_API_SECRET="Optional" +TWILIO_ACCOUNT_SID="Optional" +TWILIO_VIDEO_API_KEY="Optional" +TWILIO_VIDEO_API_SECRET="Optional" # For Twitch live stream integration # (https://dev.twitch.tv/docs) -export TWITCH_CLIENT_ID="Optional" -export TWITCH_CLIENT_SECRET="Optional" -export TWITCH_WEBHOOK_SECRET="Optional" +TWITCH_CLIENT_ID="Optional" +TWITCH_CLIENT_SECRET="Optional" +TWITCH_WEBHOOK_SECRET="Optional" # For calling the Stack Exchange API # (https://api.stackexchange.com/docs) -export STACK_EXCHANGE_APP_KEY="" +STACK_EXCHANGE_APP_KEY="" # For calling the Github API # (https://docs.github.com/) -export GITHUB_KEY="Optional" -export GITHUB_SECRET="Optional" +GITHUB_KEY="Optional" +GITHUB_SECRET="Optional"