better layout

[discourse_docker.git] / samples / standalone.yml

diff --git a/samples/standalone.yml b/samples/standalone.yml
index ee3eb3cdf4cf290b65464d9820a8d6581f42fabd..c6d4f9f0b6bd97c145461c49d533a6eb2f718be6 100644 (file)
--- a/samples/standalone.yml
+++ b/samples/standalone.yml
@@ -1,36 +1,40 @@
+## 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
 ##
-## Make sure to obey YAML syntax! You can use this site to help check:
-## http://www.yamllint.com/
-
-## this is the all-in-one, standalone Discourse Docker container template
-
-# You may add rate limiting by uncommenting the web.ratelimited template.
-# Out of the box it allows 12 reqs a second per ip, and 100 per minute per ip
-# This is configurable by amending the params in this file
+## 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/postgres.template.yml"
   - "templates/redis.template.yml"
   - "templates/web.template.yml"
-  - "templates/sshd.template.yml"
   - "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"   # fwd host port 80   to container port 80 (http)
-  - "2222:22" # fwd host port 2222 to container port 22 (ssh)
+  - "80:80"   # http
+  - "443:443" # https
 
 params:
   db_default_text_search_config: "pg_catalog.english"
-  ## Set db_shared_buffers to 1/3 of the memory you wish to allocate to postgres
-  ## on 1GB install set to 128MB on a 4GB instance you may raise to 1GB
+
+  ## 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
 
@@ -38,8 +42,8 @@ env:
   LANG: en_US.UTF-8
   # DISCOURSE_DEFAULT_LOCALE: en
 
-  ## TODO: How many concurrent web requests are supported?
-  ## With 2GB we recommend 3-4 workers, with 1GB only 2
+  ## 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
@@ -48,15 +52,24 @@ env:
 
   ## 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)
+  #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
@@ -69,27 +82,25 @@ volumes:
       guest: /var/log
 
 ## The docker manager plugin allows you to one-click upgrade Discourse
-## http://discourse.example.com/admin/docker
+## 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
 
-  ## If you want to authorized additional users, uncomment and change:
-  #- exec: ssh-import-id username
-  #- exec: ssh-import-id anotherusername
-
   - exec: echo "End of custom commands"
-  - exec: awk -F\# '{print $1;}' ~/.ssh/authorized_keys | awk 'BEGIN { print "Authorized SSH keys for this container:"; } NF>=2 {print $NF;}'