Re-arrange env examples for clarity.

pull/1005/head
Rick Carlino 2018-10-04 12:55:42 -05:00
parent ef044af8b9
commit 8245bf40f1
1 changed files with 68 additions and 50 deletions

View File

@ -12,12 +12,10 @@
# Again, PLEASE READ ALL ENTRIES. This is the most important setup step.
# =============================================================================
#
# Self hosting users can safely delete this (a new key will be created).
# This key is used to exchange secrets between bots and MQTT servers (important
# if you don't use SSL)
# SERVER WONT WORK IF YOU FORGET TO DELETE THIS EXAMPLE TEXT BELOW.
# ADD A REAL RSA_KEY OR DELETE THIS LINE!!
RSA_KEY=Change this! Keys look like `-----BEGIN RSA .........`
# Where is your MQTT server running? 99% of setups will use the same value
# found in API_HOST. Heroku users will not use the same value.
# Use a REAL, PUBLIC IP ADDRESS if you are controlling real bots.
MQTT_HOST=98.76.54.32
# If your server is on a domain (eg=my-own-farmbot.com), put it here.
# DONT USE `localhost`.
# DONT USE `127.0.0.1`.
@ -27,19 +25,57 @@ API_HOST=12.34.56.78
# 3000 for local development. 443 is using SSL. You will need `sudo` to use PORT
# 80 on most systems.
API_PORT=3000
# This can be set to anything.
# Most users can just delete it.
# This is used for people writing modifications to the software, mostly.
DOCS=Set this to any value if you want to generate API docs after running tests
# Used by people who pay for managed database hosting.
# Most users should delete this.
# DATABASE_URL=postgres://USERNAME:PASSWORD@URL:PORT/DB_NAME
DATABASE_URL=postgres://postgres:password_here@db:5432/postgres
# Every server needs to set this. This is the password to the entire database.
# NOTE: Must be less than 100 characters long.
POSTGRES_PASSWORD=
# MUST REPLACE. MUST BE A VERY RANDOM VALUE.
# 128 CHARACTERS LONG, HEXADECIMAL STRING (0-9, A-F)
DEVISE_SECRET=Used for devise. Generate a new value using `openssl rand -hex 64`.
# Most personal server users can delete this.
# Every server has a superuser.
# Set this to something SECURE.
ADMIN_PASSWORD=
# Secret key used by Rails.
# Generate a new value using `openssl rand -hex 64`
SECRET_KEY_BASE=
# Set this to production in most cases.
# Setting this line to production will disable debug backtraces.
# Please delete this line if you are submitting a bug report, as production mode
# will not give detailed crash reports.
RAILS_ENV=production
# Set this if you don't want to deal with email verification of new users.
# (self hosted users)
NO_EMAILS=TRUE
# If you wish to opt out of https:// (we wish you wouldn't), you can
# delete this line. Be aware that by not using SSL, users will transmit their
# passwords without encryption, making it very easy for attackers to see
# user passwords. Consider buying a domain and using a free certificate from
# Let's Encrypt.
FORCE_SSL=Remove this if not using HTTPS://
# Continue reading if you:
# * work at FarmBot, Inc.
# * need email notification support
# * pay for managed database / file hosting (Google Cloud)
# * use the test suite to write new features
# * run your own NervesHub instance for custom FBOS updates
# If running a FarmBot setup for personal use or none of the above apply, you
# can safely delete the rest of this file.
# For email delivery. Who is your email host?
SMTP_HOST=smtp.sendgrid.net
# Optional with default of 587
SMTP_PORT=587
# FarmBot, Inc. uses SendGrid to send emails.
# Delete these if you aren't a send grid customer.
SENDGRID_PASSWORD=Used by FarmBot, Inc
SENDGRID_USERNAME=Used by FarmBot, Inc
# Used by people who pay for managed database hosting.
# Most users should delete this.
DATABASE_URL=postgres://user:password@host:5432/db_name
# FarmBot OS update server. Use default if you don't have a special use case.
# Off grid servers may have issues connecting to our update URL.
OS_UPDATE_SERVER=https://api.github.com/repos/farmbot/farmbot_os/releases/latest
@ -53,26 +89,19 @@ GCS_BUCKET=GOOGLE_CLOUD_STORAGE_BUCKET_NAME_FOR_IMAGE_FILES
GCS_ID=GOOGLE_CLOUD_STORAGE='interop' id
# Most self hosting users will want to delete this.
GCS_KEY=GOOGLE_CLOUD_STORAGE='interop' key
# Most self hosting users will want to delete this.
HEROKU_SLUG_COMMIT=This is set by Heroku, used by Frontend to show current version.
# Where is your MQTT server running? 99% of setups will use the same value
# found in API_HOST. Heroku users will not use the same value.
# Use a REAL IP ADDRESS if you are controlling real bots.
MQTT_HOST=98.76.54.32
# Same as above. Can be deleted unless you are a Rollbar.IO customer.
# Can be deleted unless you are a Rollbar customer.
ROLLBAR_ACCESS_TOKEN=____
ROLLBAR_CLIENT_TOKEN=____
# FarmBot, Inc. uses SendGrid to send emails.
# Delete these if you don't use send grid.
SENDGRID_PASSWORD=Used by FarmBot, Inc
SENDGRID_USERNAME=Used by FarmBot, Inc
# For email delivery. Who is your email host?
SMTP_HOST=smtp.sendgrid.net
# Optional with default of 587
SMTP_PORT=587
# Set this if you don't want to deal with email verification of new users.
# (self hosted users)
NO_EMAILS=TRUE
# This can be set to anything.
# Most users can just delete it.
# This is used for people writing modifications to the software, mostly.
DOCS=Set this to any value if you want to generate API docs after running tests
# Most self hosting users will want to delete this.
HEROKU_SLUG_COMMIT=This is set by Heroku, used by Frontend to show current version.
# If you are a software developer and you wish to run integration tests, set the
# ENV below to true.
# Most users will not want this enabled.
RUN_CAPYBARA=true
# Self hosting users can delete this line.
# If you are not using the standard MQTT broker (eg=you use a 3rd party
# MQTT vendor), you will need to change this line.
@ -85,23 +114,6 @@ MQTT_VHOST=/
# can securly host the same server on multiple domain names
# ex=my.farm.bot, my.farmbot.io
EXTRA_DOMAINS=staging.farm.bot,whatever.farm.bot
# If you are a software developer and you wish to run integration tests, set the
# ENV below to true.
# Most users will not want this enabled.
RUN_CAPYBARA=true
# Set this to production in most cases.
# Setting this line to production will disable debug backtraces.
# Please delete this line if you are submitting a bug report on the forum/Github
RAILS_ENV=production
# Every server has a superuser.
# Set this to something SECURE.
ADMIN_PASSWORD=
# Every server needs to set this.
# This is the password to the entire database.
POSTGRES_PASSWORD=
# Secret key used by Rails.
# Generate a new value using `openssl rand -hex 64`
SECRET_KEY_BASE=
# Some hosts (Eg=FarmBot, Inc.) run the RabbitMQ management API on a
# non-standard host.
# Include the protocol! (http vs. https)
@ -113,6 +125,12 @@ RABBIT_MGMT_URL=http://delete_this_line.com
# to use the server.
# DELETE THIS LINE IF YOU RUN A PUBLIC SERVER.
TRUSTED_DOMAINS=farmbot.io,farm.bot
# Self hosting users can safely delete this (a new key will be created).
# This key is used to exchange secrets between bots and MQTT servers (important
# if you don't use SSL)
# SERVER WONT WORK IF YOU FORGET TO DELETE THIS EXAMPLE TEXT BELOW.
# ADD A REAL RSA_KEY OR DELETE THIS LINE!!
RSA_KEY=Change this! Keys look like `-----BEGIN RSA .........`
# Nerves Hub Configuration
# Nerves Hub handles OTA Firmware updates.
# DELETE THIS LINE if you are a self-hosted user.