better layout
[discourse_docker.git] / samples / standalone.yml
index 2dae4e787698db268b2f52e8f68a54bb830670b6..c6d4f9f0b6bd97c145461c49d533a6eb2f718be6 100644 (file)
-# this is the base templates used, you can cut it down to include less functionality per container
+## this is the all-in-one, standalone Discourse Docker container template
+##
+## After making changes to this file, you MUST rebuild for any changes
+## to take effect in your live Discourse instance:
+##
+## /var/discourse/launcher rebuild app
+##
+## BE *VERY* CAREFUL WHEN EDITING!
+## YAML FILES ARE SUPER SUPER SENSITIVE TO MISTAKES IN WHITESPACE OR ALIGNMENT!
+## visit http://www.yamllint.com/ to validate this file as needed
+
 templates:
-  - "templates/cron.template.yml"
   - "templates/postgres.template.yml"
   - "templates/redis.template.yml"
-  - "templates/sshd.template.yml"
   - "templates/web.template.yml"
-# which ports to expose?
+  - "templates/web.ratelimited.template.yml"
+## Uncomment these two lines if you wish to add Lets Encrypt (https)
+  #- "templates/web.ssl.template.yml"
+  #- "templates/web.letsencrypt.ssl.template.yml"
+## which TCP/IP ports should this container expose?
+## If you want Discourse to share a port with another webserver like Apache or nginx,
+## see https://meta.discourse.org/t/17247 for details
 expose:
-  - "80:80"
-  - "2222:22"
+  - "80:80"   # http
+  - "443:443" # https
 
 params:
-  # git revision to run
-  version: HEAD
+  db_default_text_search_config: "pg_catalog.english"
 
+  ## Set db_shared_buffers to a max of 25% of the total memory.
+  ## this will be set automatically by ./launcher memconfig app
+  #db_shared_buffers: "256MB"
+  
+  ## this can improve sorting performance, but adds memory usage per-connection
+  #db_work_mem: "40MB"
+  
+  ## Which Git revision should this container use? (default: tests-passed)
+  #version: tests-passed
 
 env:
-  # your email here
-  DISCOURSE_DEVELOPER_EMAILS: 'my_email@email.com'
-  # CHANGE ME to your hostname
-  DISCOURSE_HOSTNAME: 'www.example.com'
-  # SET ME to your smtp server eg mandrill
-  # don't forget to set mail
-  # DISCOURSE_SMTP_ADDRESS: smtp.mandrillapp.com
-  # DISCOURSE_SMTP_PORT: 587
-  # DISCOURSE_SMTP_USER_NAME: user@example.com
-  # DISCOURSE_SMTP_PASSWORD: p@ssword
+  LANG: en_US.UTF-8
+  # DISCOURSE_DEFAULT_LOCALE: en
+
+  ## How many concurrent web requests are supported? Depends on memory and CPU cores.
+  ## this will be set automatically by ./launcher memconfig app
+  #UNICORN_WORKERS: 3
+
+  ## TODO: List of comma delimited emails that will be made admin and developer
+  ## on initial signup example 'user1@example.com,user2@example.com'
+  DISCOURSE_DEVELOPER_EMAILS: 'me@example.com'
+
+  ## TODO: The domain name this Discourse instance will respond to
+  DISCOURSE_HOSTNAME: 'discourse.example.com'
+  
+  ## Uncomment if you want the container to be started with the same
+  ## hostname (-h option) as specified above (default "$hostname-$config")
+  #DOCKER_USE_HOSTNAME: true
+
+  ## TODO: The mailserver this Discourse instance will use
+  DISCOURSE_SMTP_ADDRESS: smtp.example.com         # (mandatory)
+  #DISCOURSE_SMTP_PORT: 587                        # (optional)
+  #DISCOURSE_SMTP_USER_NAME: user@example.com      # (optional)
+  #DISCOURSE_SMTP_PASSWORD: pa$$word               # (optional, WARNING the char '#' in pw can cause problems!)
+  #DISCOURSE_SMTP_ENABLE_START_TLS: true           # (optional, default true)
+  
+  ## The Let's Encrypt email will allow you to register a FREE SSL certificate.
+  ## If you added the Let's Encrypt template, uncomment below to automatically get certificates.
+  #LETSENCRYPT_ACCOUNT_EMAIL: email@awesomedomain.com
 
+  ## The CDN address for this Discourse instance (configured to pull)
+  ## see https://meta.discourse.org/t/14857 for details
+  #DISCOURSE_CDN_URL: //discourse-cdn.example.com
+
+## These containers are stateless, all data is stored in /shared
 volumes:
   - volume:
-      host: /var/docker/shared
+      host: /var/discourse/shared/standalone
       guest: /shared
+  - volume:
+      host: /var/discourse/shared/standalone/log/var-log
+      guest: /var/log
 
-# you may use the docker manager to upgrade and monitor your docker image
-# UI will be visible at http://yoursite.com/admin/docker
+## The docker manager plugin allows you to one-click upgrade Discourse
+## http://discourse.example.com/admin/upgrade
 hooks:
   after_code:
     - exec:
         cd: $home/plugins
         cmd:
-          - mkdir -p plugins
           - git clone https://github.com/discourse/docker_manager.git
+
+## Remember, this is YAML syntax - you can only have one block with a name
+run:
+  - exec: echo "Beginning of custom commands"
+
+  ## If you want to set the 'From' email address for your first registration, uncomment and change:
+  ## After getting the first signup email, re-comment the line. It only needs to run once.
+  #- exec: rails r "SiteSetting.notification_email='info@unconfigured.discourse.org'"
+  
+  ## If you want to configure password login for root, uncomment and change:
+  ## Use only one of the following lines:
+  #- exec: /usr/sbin/usermod -p 'PASSWORD_HASH' root
+  #- exec: /usr/sbin/usermod -p "$(mkpasswd -m sha-256 'RAW_PASSWORD')" root
+
+  - exec: echo "End of custom commands"