.env.example 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266
  1. # ==== Required configuration settings for Huginn ====
  2. # Replace the following with the output from "rake secret"
  3. APP_SECRET_TOKEN=REPLACE_ME_NOW!
  4. # This is the domain where your Huginn instance will be running. The default should work
  5. # for development, but it needs to be changed to your Huginn domain when you deploy to a
  6. # production environment (e.g., yourdomain.com, possibly including a port).
  7. DOMAIN=localhost:3000
  8. PORT=3000
  9. # Optionally set an asset host
  10. # ASSET_HOST=http://assets.example.com
  11. ############################
  12. # Database Setup #
  13. ############################
  14. DATABASE_ADAPTER=mysql2
  15. DATABASE_ENCODING=utf8
  16. DATABASE_RECONNECT=true
  17. DATABASE_NAME=huginn_development
  18. DATABASE_POOL=20
  19. DATABASE_USERNAME=root
  20. DATABASE_PASSWORD=""
  21. #DATABASE_HOST=your-domain-here.com
  22. #DATABASE_PORT=3306
  23. #DATABASE_SOCKET=/tmp/mysql.sock
  24. # MySQL only: If you are running a MySQL server >=5.5.3, you should
  25. # set DATABASE_ENCODING to utf8mb4 instead of utf8 so that the
  26. # database can hold 4-byte UTF-8 characters like emoji.
  27. #DATABASE_ENCODING=utf8mb4
  28. # ==== Additional required production settings ====
  29. # Configure Rails environment. This should only be needed in production and may cause errors in development.
  30. # RAILS_ENV=production
  31. # Should Rails force all requests to use SSL?
  32. FORCE_SSL=false
  33. ################################################
  34. # User authentication and registration #
  35. ################################################
  36. # This invitation code will be required for users to signup with your Huginn installation.
  37. # You can see its use in user.rb. PLEASE CHANGE THIS!
  38. INVITATION_CODE=try-huginn
  39. # If you don't want to require new users to have an invitation code in order to sign up, set this to true.
  40. SKIP_INVITATION_CODE=false
  41. # If you'd like to require new users to confirm their email address after sign up, set this to true.
  42. REQUIRE_CONFIRMED_EMAIL=false
  43. # If REQUIRE_CONFIRMED_EMAIL is true, set this to the duration in which a user needs to confirm their email address.
  44. ALLOW_UNCONFIRMED_ACCESS_FOR=2.days
  45. # Duration for which the above confirmation token is valid
  46. CONFIRM_WITHIN=3.days
  47. # Minimum password length
  48. MIN_PASSWORD_LENGTH=8
  49. # Duration for which the reset password token is valid
  50. RESET_PASSWORD_WITHIN=6.hours
  51. # Set to 'failed_attempts' to lock user accounts for the UNLOCK_AFTER period they fail MAX_FAILED_LOGIN_ATTEMPTS login attempts. Set to 'none' to allow unlimited failed login attempts.
  52. LOCK_STRATEGY=failed_attempts
  53. # After how many failed login attempts the account is locked when LOCK_STRATEGY is set to failed_attempts.
  54. MAX_FAILED_LOGIN_ATTEMPTS=10
  55. # Can be set to 'email', 'time', 'both' or 'none'. 'none' requires manual unlocking of your users!
  56. UNLOCK_STRATEGY=both
  57. # Duration after which the user is unlocked when UNLOCK_STRATEGY is 'both' or 'time' and LOCK_STRATEGY is 'failed_attempts'
  58. UNLOCK_AFTER=1.hour
  59. # Duration for which the user will be remembered without asking for credentials again.
  60. REMEMBER_FOR=4.weeks
  61. # Set to 'true' if you would prefer new users to start with a default set of agents
  62. IMPORT_DEFAULT_SCENARIO_FOR_ALL_USERS=true
  63. # Users can be given a default set of agents to get them started
  64. # You can override this scenario with your own scenario via file path or URL
  65. # DEFAULT_SCENARIO_FILE=path-or-url-to-scenario.json
  66. #############################
  67. # Email Configuration #
  68. #############################
  69. # Outgoing email settings. To use Gmail or Google Apps, put your Google Apps domain or gmail.com
  70. # as the SMTP_DOMAIN and your Gmail username and password as the SMTP_USER_NAME and SMTP_PASSWORD.
  71. #
  72. # PLEASE NOTE: In order to enable sending real emails via SMTP locally (e.g., when not in the production Rails environment),
  73. # you must also set SEND_EMAIL_IN_DEVELOPMENT to true below.
  74. #
  75. # If you have trouble with port 587 on Gmail, you can also try setting
  76. # SMTP_AUTHENTICATION to login and the SMTP_PORT to 465.
  77. #
  78. # If you use a local SMTP server without authentication such as Postfix,
  79. # set SMTP_AUTHENTICATON to `none`.
  80. # Uncomment if you want to use `/usr/sbin/sendmail` to send email instead of SMTP.
  81. # This option is ignored unless RAILS_ENV=production, and setting it to `sendmail` causes the settings in the rest of this section (except EMAIL_FROM_ADDRESS) to be ignored.
  82. # SMTP_DELIVERY_METHOD=sendmail
  83. SMTP_DOMAIN=your-domain-here.com
  84. SMTP_SERVER=smtp.gmail.com
  85. SMTP_PORT=587
  86. SMTP_ENABLE_STARTTLS_AUTO=true
  87. SMTP_SSL=false
  88. SMTP_AUTHENTICATION=plain
  89. # SMTP_USER_NAME=you@gmail.com
  90. # SMTP_PASSWORD=somepassword
  91. # or without authentication:
  92. # SMTP_AUTHENTICATION=none
  93. # Set to true to send real emails via SMTP when running in the development Rails environment.
  94. # Set to false to have emails intercepted in development and displayed at http://localhost:3000/letter_opener
  95. SEND_EMAIL_IN_DEVELOPMENT=false
  96. # The address from which system emails will appear to be sent.
  97. EMAIL_FROM_ADDRESS=from_address@gmail.com
  98. ###########################
  99. # Agent Logging #
  100. ###########################
  101. # Number of lines of log messages to keep per Agent
  102. AGENT_LOG_LENGTH=200
  103. #######################################################################################################
  104. # OAuth Configuration #
  105. # More information at the wiki: https://github.com/huginn/huginn/wiki/Configuring-OAuth-applications #
  106. #######################################################################################################
  107. TWITTER_OAUTH_KEY=
  108. TWITTER_OAUTH_SECRET=
  109. THIRTY_SEVEN_SIGNALS_OAUTH_KEY=
  110. THIRTY_SEVEN_SIGNALS_OAUTH_SECRET=
  111. GITHUB_OAUTH_KEY=
  112. GITHUB_OAUTH_SECRET=
  113. TUMBLR_OAUTH_KEY=
  114. TUMBLR_OAUTH_SECRET=
  115. DROPBOX_OAUTH_KEY=
  116. DROPBOX_OAUTH_SECRET=
  117. EVERNOTE_OAUTH_KEY=
  118. EVERNOTE_OAUTH_SECRET=
  119. # Set to true in development, false in production
  120. USE_EVERNOTE_SANDBOX=true
  121. GOOGLE_CLIENT_ID=
  122. GOOGLE_CLIENT_SECRET=
  123. #############################
  124. # AWS and Mechanical Turk #
  125. #############################
  126. # AWS Credentials for MTurk
  127. AWS_ACCESS_KEY_ID="your aws access key id"
  128. AWS_ACCESS_KEY="your aws access key"
  129. # Set AWS_SANDBOX to true if you're developing Huginn code.
  130. AWS_SANDBOX=false
  131. #########################
  132. # Additional Agent gems #
  133. #########################
  134. # Agent gems can be added to Huginn by specifying them in a comma separated
  135. # list, the gem version and arguments for the gem command are optional.
  136. # When not providing a git(hub) repository the gem needs to be published to
  137. # https://rubygems.org.
  138. # Check http://bundler.io/v1.11/git.html for a list of valid arguments.
  139. #
  140. # Configuration examples:
  141. #
  142. # ADDITIONAL_GEMS=huginn_nlp_agents,test_agent
  143. # ADDITIONAL_GEMS=huginn_nlp_agents(~> 0.2.1),test_agent
  144. # ADDITIONAL_GEMS=huginn_nlp_agents(git: https://github.com/kreuzwerker/DKT.huginn_nlp_agents.git),test_agent
  145. # ADDITIONAL_GEMS=huginn_nlp_agents(github: kreuzwerker/DKT.huginn_nlp_agents),test_agent
  146. # ADDITIONAL_GEMS=huginn_nlp_agents(~> 0.2.1, git: https://github.com/kreuzwerker/DKT.huginn_nlp_agents.git),test_agent
  147. ########################
  148. # Various Settings #
  149. ########################
  150. # Specify the HTTP backend library for Faraday, commonly used by
  151. # WebsiteAgent, RssAgent and PostAgent. You can change this depending
  152. # on the performance and stability you need for your service. Any
  153. # choice other than "typhoeus", "net_http", or "em_http" should
  154. # require you to bundle a corresponding gem via Gemfile.
  155. FARADAY_HTTP_BACKEND=typhoeus
  156. # Specify the default User-Agent header value for HTTP requests made
  157. # by Agents that allow overriding the User-Agent header value.
  158. DEFAULT_HTTP_USER_AGENT="Huginn - https://github.com/huginn/huginn"
  159. # Enable this setting to allow insecure Agents like the ShellCommandAgent. Only do this
  160. # when you trust everyone using your Huginn installation.
  161. ENABLE_INSECURE_AGENTS=false
  162. # Enable this setting to allow second precision schedule in
  163. # SchedulerAgent. By default, the use of the "second" field is
  164. # restricted so that any value other than a single zero (which means
  165. # "on the minute") is disallowed to prevent abuse of service.
  166. ENABLE_SECOND_PRECISION_SCHEDULE=false
  167. # Specify the scheduler frequency in seconds (default: 0.3).
  168. # Increasing this value will help reduce the use of system resources
  169. # at the expense of time accuracy.
  170. SCHEDULER_FREQUENCY=0.3
  171. # Specify the frequency with which the scheduler checks for and cleans up expired events.
  172. # You can use `m` for minutes, `h` for hours, and `d` for days.
  173. EVENT_EXPIRATION_CHECK=6h
  174. # Enable JqAgent which uses jq. Specify a file path to the jq(1)
  175. # command or just `jq`. This is not enabled by default because jq can
  176. # cause infinite loop and is not suitable for public service.
  177. # Only uncomment this when you trust everyone using your Huginn
  178. # installation.
  179. #USE_JQ=jq
  180. # Use Graphviz for generating diagrams instead of using Google Chart
  181. # Tools. Specify a dot(1) command path built with SVG support
  182. # enabled.
  183. #USE_GRAPHVIZ_DOT=dot
  184. # Default layout for agent flow diagrams generated by Graphviz.
  185. # Choose from `circo`, `dot` (default), `fdp`, `neato`, `osage`,
  186. # `patchwork`, `sfdp`, or `twopi`. Note that not all layouts are
  187. # supported by Graphviz depending on the build options.
  188. #DIAGRAM_DEFAULT_LAYOUT=dot
  189. # Timezone. Use `rake time:zones:local` or `rake time:zones:all` to get your zone name
  190. TIMEZONE="Pacific Time (US & Canada)"
  191. # Number of failed jobs to keep in the database
  192. FAILED_JOBS_TO_KEEP=100
  193. # Maximum runtime of background jobs in minutes
  194. DELAYED_JOB_MAX_RUNTIME=2
  195. # Amount of seconds for delayed_job to sleep before checking for new jobs
  196. DELAYED_JOB_SLEEP_DELAY=10
  197. ################################################################################
  198. # Capistrano deployment, read the documentation: #
  199. # https://github.com/huginn/huginn/blob/master/doc/manual/capistrano.md#readme #
  200. ################################################################################
  201. #CAPISTRANO_DEPLOY_SERVER=
  202. #CAPISTRANO_DEPLOY_USER=
  203. #CAPISTRANO_DEPLOY_REPO_URL=