Auto-prepend dot to baseDomain if it's not present,

Document baseDomain usage in readme a bit more.
Addresses: exoframejs/exoframe#111

Author: yamalight

README.md

@@ -58,18 +58,43 @@ Exoframe stores its config in `~/.exoframe/server.config.yml`.
 Currently it contains the following settings:
 
 ```yaml
-debug: false # whether debug mode is enabled, default "false"
-letsencrypt: false # whether to enable letsencrypt, default "false"
-letsencryptEmail: your@email.com # email used for letsencrypt
-compress: true # whether to apply gzip compression, default "true"
-baseDomain: false # base domain to use for deployments without domains specified, default "false"
-cors: false # CORS support; can be "true" ("*" header) or object with "origin" property, default "false"
-traefikImage: 'traefik:latest' # Traefik image to be used; set to "false" to disable traefik management, default "traefik:latest"
-traefikName: 'exoframe-traefik' # Traefik container name, default "exoframe-traefik"
-traefikArgs: [] # Additional Traefik start args, default []
-exoframeNetwork: 'exoframe' # Network used by traefik to connect services to, default "exoframe"
-updateChannel: 'stable' # server image update channel; can be "stable" or "nightly", default "stable"
-publicKeysPath: '/path/to/your/public/keys' # path to folder with authorized_keys, default "~/.ssh"
+# whether debug mode is enabled, default "false"
+debug: false
+
+# whether to enable letsencrypt, default "false"
+letsencrypt: false
+
+# email used for letsencrypt
+letsencryptEmail: your@email.com
+
+# whether to apply gzip compression, default "true"
+compress: true
+
+# base top-level domain to use for deployments without domains specified, default "false"
+# used as postfix, e.g. if you specify ".example.com" (dot is auto-prepended if not present)
+# all your deployments will be autodeployed as "deployment-id.example.com"
+baseDomain: false
+
+# CORS support; can be "true" ("*" header) or object with "origin" property, default "false"
+cors: false
+
+# Traefik image to be used; set to "false" to disable traefik management, default "traefik:latest"
+traefikImage: 'traefik:latest'
+
+# Traefik container name, default "exoframe-traefik"
+traefikName: 'exoframe-traefik'
+
+# Additional Traefik start args, default []
+traefikArgs: []
+
+# Network used by traefik to connect services to, default "exoframe"
+exoframeNetwork: 'exoframe'
+
+# server image update channel; can be "stable" or "nightly", default "stable"
+updateChannel: 'stable'
+
+# path to folder with authorized_keys, default "~/.ssh"
+publicKeysPath: '/path/to/your/public/keys'
 ```
 
 _Warning:_ Most changes to config are applied immediately. With exception of Letsencrypt config. If you are enabling letsencrypt after Traefik instance has been started, you'll need to remove Traefik and then restart Exoframe server for changes to take effect.

src/docker/start.js

@@ -14,7 +14,11 @@ module.exports = async ({image, username, resultStream}) => {
   const config = getProjectConfig();
 
   // generate host
-  const defaultDomain = serverConfig.baseDomain ? `${name}${serverConfig.baseDomain}` : undefined;
+  // construct base domain from config, prepend with "." if it's not there
+  const baseDomain = serverConfig.baseDomain ? serverConfig.baseDomain.replace(/^(\.?)/, '.') : undefined;
+  // construc default domain using given base domain
+  const defaultDomain = baseDomain ? `${name}${baseDomain}` : undefined;
+  // construct host
   const host = config.domain === undefined ? defaultDomain : config.domain;
 
   // generate env vars

test/fixtures/server.config.yml

@@ -1,6 +1,6 @@
 debug: true
 letsencrypt: false
 letsencryptEmail: test@gmail.com
-baseDomain: '.test'
+baseDomain: 'test'
 cors:
   origin: 'http://test.com'