Meteor Up

https://github.com/zodern/meteor-up
Admin
Meteor Up is a command-line tool that enables production-quality deployments of Meteor applications...
Tokens:86,446
Snippets:696
Trust Score:8.4
License:MIT
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### mup proxy CLI usage examples

Source: https://github.com/zodern/meteor-up/blob/master/_autodocs/api-reference/proxy-plugin.md

Shows common mup proxy commands: setup, reconfig-shared, logs-le, nginx-config, status --overview, and reconfig. The status --overview flag is only supported on mup status routes.

```bash
mup proxy setup                    # full proxy + nginx + ssl setup
mup proxy reconfig-shared          # apply proxy.shared.* changes
mup proxy logs-le                  # let's encrypt container logs
mup proxy nginx-config             # dump the generated nginx config
mup proxy status --overview        # (overview is only supported on `mup status` routes)
mup reconfig                       # triggers post.reconfig → updateProxyForLoadBalancing
```

--------------------------------

### Usage example for swarm-utils

Source: https://github.com/zodern/meteor-up/blob/master/_autodocs/api-reference/swarm-utils.md

Example demonstrating how to check for multiple clusters and calculate manager changes.

```js
import { currentManagers, desiredManagers, findClusters } from './swarm-utils';

const info = await api.getServerInfo();
const clusters = findClusters(info);
if (Object.keys(clusters).length > 1) {
  showClusters(clusters, nodeIdsToServer(info));
  throw new Error('multiple-clusters');
}

const toRemove = intersection(currentManagers(info), desiredManagers(config, info));
console.log('managers to demote:', difference(currentManagers(info), desiredManagers(config, info)));
```

--------------------------------

### Usage example for getOptions

Source: https://github.com/zodern/meteor-up/blob/master/_autodocs/api-reference/swarm-options.md

Usage example showing how to call `getOptions` with the full mup config and log the resulting managers and labels. The comment shows the shape of the labels object.

```javascript
import { getOptions } from './swarm-options';

const { labels, managers } = getOptions(api.getConfig());
console.log('requested swarm managers:', managers);
console.log('desired node labels:', labels);
// { one: { 'mup-app-myapp': 'true', 'tier': 'web' }, ... }
```

--------------------------------

### mup mongo CLI commands

Source: https://github.com/zodern/meteor-up/blob/master/_autodocs/api-reference/mongo-plugin.md

Commands to manage the MongoDB container in single-server setups. `mup mongo setup` installs the container, `start` starts it, `shell` opens an interactive mongosh, `logs --tail 50` passes through docker logs, and `status --overview` shows status.

```bash
mup mongo setup          # install mongo container (single-server setups only)
mup mongo start          # start container
mup mongo shell          # interactive mongosh into the app's database
mup mongo logs --tail 50 # docker log passthrough on 'mongodb' container
mup mongo status --overview
```

--------------------------------

### Proxy configuration example

Source: https://github.com/zodern/meteor-up/blob/master/_autodocs/api-reference/proxy-plugin.md

Example proxy configuration object with domains, SSL settings, load balancing, sticky sessions, and shared ports.

```javascript
proxy: {
  domains: 'app.com,www.app.com',
  ssl: { letsEncryptEmail: 'me@example.com' },
  loadBalancing: true,
  stickySessions: true,
  shared: { httpPort: 80, httpsPort: 443 }
}
```

--------------------------------

### Setup and reconfigure proxy

Source: https://github.com/zodern/meteor-up/blob/master/docs/docs.md

Run `mup setup` and `mup reconfig` after stopping apps to set up the reverse proxy.

```bash
mup setup
mup reconfig
```

--------------------------------

### mup setup command

Source: https://github.com/zodern/meteor-up/wiki/Home

Command to set up the server after creating and filling the mup.js file.

```bash
mup setup
```

--------------------------------

### Usage example

Source: https://github.com/zodern/meteor-up/blob/master/_autodocs/api-reference/server-info.md

Example of calling `getServerInfo` without arguments to use default collectors, accessing the returned info, and using `serverInfoStale` to drop the cache.

```APIDOC
## Usage example

### Description
Shows how to call `getServerInfo` with default collectors, access returned properties, and invalidate the cache with `serverInfoStale`.

### Example Code
```js
const info = await api.getServerInfo();   // default collectors, caches result
console.log(info.myserver.swarm.LocalNodeState);   // 'active'
const token = info.myserver.swarmToken;            // worker join token

api.serverInfoStale();                    // drop the cache before re-collecting
```

```

--------------------------------

### Run mup setup and mup deploy

Source: https://github.com/zodern/meteor-up/blob/master/docs/docs.md

After changing the config for the built-in MongoDB, run these commands to set up and deploy.

```bash
mup setup
```

```bash
mup deploy
```

--------------------------------

### Install NPM dependencies

Source: https://github.com/zodern/meteor-up/blob/master/CONTRIBUTING.md

Installs the NPM dependencies for the meteor-up project. This is the first step to run the docs website locally.

```bash
npm install
```

--------------------------------

### Usage example: task list with executeScript and copy

Source: https://github.com/zodern/meteor-up/blob/master/_autodocs/api-reference/nodemiral.md

Shows how to create a task list, add an executeScript and a copy task, and run it. Includes a comment about retry behavior for 'No such file' failures.

```javascript
import nodemiral from '@zodern/nodemiral';

const list = nodemiral.taskList('Setup App');
list.executeScript('Setup Environment', {
  script: api.resolvePath(__dirname, 'assets/app-setup.sh'),
  vars: { name: config.app.name }
});
list.copy('Pushing the Startup Script', {
  src: api.resolvePath(__dirname, 'assets/templates/start.sh'),
  dest: `/opt/${config.app.name}/config/start.sh`,
  hostVars,                       // per-host var overrides
  vars: { appName: config.app.name }
});

await api.runTaskList(list, api.getSessions(['app']), { verbose: api.verbose });
// 'No such file' failures get err.solution and are retried up to 4 times
```

--------------------------------

### Docker CLI commands for setup and management

Source: https://github.com/zodern/meteor-up/blob/master/_autodocs/api-reference/docker-plugin.md

Commands to set up Docker and a swarm cluster, check status, list containers, update Docker, and destroy the cluster.

```bash
mup docker setup                 # install docker, create/join swarm, apply labels
mup docker status                # per-host docker version + swarm node list
mup docker ps --format "{{.Names}}"  # docker ps passthrough
mup docker update                # update docker and re-converge the cluster
mup docker destroy-cluster       # leave the swarm on every server
```

--------------------------------

### Install Meteor Up globally with npm

Source: https://github.com/zodern/meteor-up/blob/master/README.md

Install Meteor Up globally using npm. Requires Node v8 or newer and should be run on the computer you are deploying from.

```bash
npm install -g mup
```

--------------------------------

### command-handlers.js exports: deploy, logs, reconfig, restart, setup, start, stop, ssh, validate, status

Source: https://github.com/zodern/meteor-up/blob/master/_autodocs/api-reference/default-plugin.md

Exports the command handlers for the default plugin. Most are no-ops beyond logging; setup runs 'docker.setup', ssh opens an interactive shell, validate checks config, and status reports server OS info.

```javascript
export function deploy() { ... }    // handlers.js:8   (no-op beyond logging)
export function logs() { ... }      // handlers.js:12  (no-op)
export function reconfig() { ... }  // handlers.js:16  (no-op)
export function restart() { ... }   // handlers.js:20  (no-op)
export function setup(api) { ... }  // handlers.js:24  → api.runCommand('docker.setup')
export function start() { ... }     // handlers.js:38  (no-op)
export function stop() { ... }      // handlers.js:42  (no-op)
export function ssh(api) { ... }    // handlers.js:46
export function validate(api) { ... }   // handlers.js:94
export async function status(api) { ... }   // handlers.js:139
```

--------------------------------

### Mongo plugin exports

Source: https://github.com/zodern/meteor-up/blob/master/_autodocs/api-reference/plugin-modules.md

Exports the mongo plugin's description, commands, validation, prepareConfig, and hooks. The `prepareConfig` function sets default MongoDB version, database name, and MONGO_URL, and adds a Docker link. Hooks run setup and start after default setup, and status after default status.

```javascript
export const description = 'Commands to manage MongoDB';     // index.js:4
export const commands = _commands;                           // index.js:5
export const validate = { mongo: _validator };               // index.js:6
export function prepareConfig(config) { ... }                // index.js:10
export const hooks = { ... };                                // index.js:34
```

--------------------------------

### Enable Let's Encrypt SSL with letsEncryptEmail

Source: https://github.com/zodern/meteor-up/blob/master/docs/docs.md

Enable Let's Encrypt SSL by adding an `ssl` object with `letsEncryptEmail` to your `proxy` config. Requires `app.env.ROOT_URL` to start with `https://`, DNS for each domain, port 80 open, and Cloudflare SSL set to Full or Full (strict). Run `mup setup` and `mup reconfig`; certificates are automatically renewed when expiring within 30 days.

```javascript
module.exports = {
  // ... rest of config

  proxy: {
    domains: 'website.com,www.website.com',
    ssl: {
      // Enable let's encrypt to create free certificates.
      // The email is used by Let's Encrypt to notify you when the
      // certificates are close to expiring.
      letsEncryptEmail: 'email@domain.com'
    }
  }
};
```

--------------------------------

### Meteor Up Utility Usage Example

Source: https://github.com/zodern/meteor-up/blob/master/_autodocs/api-reference/meteor-utils.md

Demonstrates how to import and utilize utility functions for service configuration, node version detection, and image tagging during the build process.

```js
import { createServiceConfig, getNodeVersion, currentImageTag } from './utils';
import buildApp, { archiveApp, cleanBuildDir } from './build';
import { prepareBundleSupported } from './prepare-bundle';

const serverInfo = await api.getServerInfo();
const tag = currentImageTag(serverInfo, app.name) + 1;      // rolling numeric tag
const nodeVersion = await getNodeVersion(bundlePath);       // for prepare-bundle.sh
const config = createServiceConfig(api, tag);              // swarm service options
```

--------------------------------

### Install Jekyll gems

Source: https://github.com/zodern/meteor-up/blob/master/CONTRIBUTING.md

Changes to the docs directory and installs the required Ruby gems for Jekyll. This is the third step to set up the docs website locally.

```bash
cd docs
bundle install
```

--------------------------------

### Stop apps before proxy setup

Source: https://github.com/zodern/meteor-up/blob/master/docs/docs.md

Stop every app running on the servers before setting up the reverse proxy for the first time.

```bash
mup stop
```

--------------------------------

### Using scrubConfig to clean a config

Source: https://github.com/zodern/meteor-up/blob/master/_autodocs/api-reference/scrub-config.md

Usage example showing how to import `scrubConfig` and `utils` from `mup/lib/scrub-config`, scrub a config object, and print the result as JSON. The comment shows the scrubbed mongo URL.

```javascript
const { scrubConfig, utils } = require('mup/lib/scrub-config');

const clean = scrubConfig(api.getConfig());
console.log(JSON.stringify(clean, null, 2));
// mongo url: mongodb://user:pass@subdomain.host.com/my-app
```

--------------------------------

### Usage example with default collectors and cache invalidation

Source: https://github.com/zodern/meteor-up/blob/master/_autodocs/api-reference/server-info.md

Shows how to call getServerInfo with default collectors, access the cached result, and use serverInfoStale to drop the cache before re-collecting.

```javascript
const info = await api.getServerInfo();   // default collectors, caches result
console.log(info.myserver.swarm.LocalNodeState);   // 'active'
const token = info.myserver.swarmToken;            // worker join token

api.serverInfoStale();                    // drop the cache before re-collecting
```

--------------------------------

### Configure custom SSL certificates

Source: https://github.com/zodern/meteor-up/blob/master/docs/docs.md

Use custom SSL certificates by providing `crt` and `key` paths in the `ssl` object. Then run `mup setup`. View certificate expiry with `mup status`.

```javascript
module.exports = {
  // .. rest of config

  proxy: {
    domains: 'website.com,www.website.com',
    ssl: {
      crt: './bundle.crt',
      key: './private.pem'
    }
  }
};
```

--------------------------------

### Configure built-in MongoDB

Source: https://github.com/zodern/meteor-up/blob/master/docs/docs.md

Configure the built-in MongoDB instance. Add the mongo object to your config to start a MongoDB instance on the server and set app.env.MONGO_URL to connect to it. It is recommended to use an external database for production apps.

```js
module.exports = {
  // .. rest of config

  mongo: {
    version: '3.4.1',
    servers: {
      one: {}
    }
  }
};
```

--------------------------------

### Enable load balancing with sticky sessions

Source: https://github.com/zodern/meteor-up/blob/master/docs/docs.md

Enable load balancing across multiple servers with sticky sessions. Set `proxy.loadBalancing` to true; `stickySessions` is optional and defaults to true. Then run `mup setup` and `mup reconfig`.

```javascript
module.exports = {
  // ... rest of config

  proxy: {
    domains: 'website.com',

    loadBalancing: true,
    // Use sticky sessions when load balancing (optional, default is true)
    stickySessions: true
  }
};
```

--------------------------------

### Build and serve docs website

Source: https://github.com/zodern/meteor-up/blob/master/CONTRIBUTING.md

Returns to the project root and builds and serves the docs website. The website will be available at http://localhost:8080/.

```bash
cd ..
npm run docs
```

--------------------------------

### Run parallel tests with npm run test:parallel

Source: https://github.com/zodern/meteor-up/blob/master/CONTRIBUTING.md

Starts parallel tests on Linux. Requires node, docker, meteor, and GNU parallel; the test script automatically installs missing dependencies and sets DOCKER_OPTS to use devicemapper.

```bash
npm run test:parallel
```

--------------------------------

### Custom collectors example

Source: https://github.com/zodern/meteor-up/blob/master/_autodocs/api-reference/server-info.md

Example of defining custom collectors for `serverInfo`, with commands and parsers. The example shows two collectors: `nginxDocker` using a JSON parser and `certificateExpire` with a custom parser function. Then the function is called with these custom collectors.

```APIDOC
## Custom collectors example

### Description
Demonstrates how to define custom collectors for `serverInfo`. Each collector has a `command` and a `parser`. The `parser` can be a string (like `'json'`) or a function that receives stdout and exit code.

### Example Code
```js
const collectorConfig = {
  nginxDocker: {
    command: `docker inspect ${PROXY_CONTAINER_NAME} --format "{{json .}}"`,
    parser: 'json'
  },
  certificateExpire: {
    command: `cd /opt/.../mounted-certs && find . -name '*.chain.pem' ...`,
    parser(stdout, code) {
      if (code === 0) {
        return stdout.split('\n').reduce((result, item, index, items) => {
          if (!(index % 2) && item.trim() !== '') {
            result[item.slice(2)] = items[index + 1].split('=')[1];
          }
          return result;
        }, {});
      }
      return null;
    }
  }
};
const serverInfo = await api.getServerInfo(servers, collectorConfig);
```

```

--------------------------------

### Deploy with custom config and settings files

Source: https://github.com/zodern/meteor-up/blob/master/docs/docs.md

Use this command to deploy with a custom configuration file and settings file. The --config and --settings parameters allow you to keep multiple configuration and settings files in the same directory.

```bash
mup deploy --config=mup-staging.js --settings=staging-settings.json
```

--------------------------------

### mup.js configuration example

Source: https://github.com/zodern/meteor-up/wiki/Home

Full configuration file for meteor-up. Defines server credentials, Meteor app settings (name, path, environment variables, SSL, logs), and optional MongoDB settings. Includes comments for optional fields and defaults.

```javascript
module.exports = {
    servers: {
        one: {
            host:       '192.168.0.1',
            username:   'username',
            password:   'secret', // or leave blank for authenticate from ssh-agent
            pem:        '/fullpath/to/you_key.pem' // or leave blank for authenticate from ssh-agent
        }
    },

    meteor: {
        name: 'appname',
        path: '/Applications/MAMP/htdocs/paisano-app-13',
        servers: {
            one: {
                host:       '192.168.0.1',
                username:   'root'
            },
        },
        env: {
            PORT: 80, // optional, defaults to 80
            ROOT_URL: 'http://www.domain.co',
            MONGO_URL: 'mongodb://your:mongo@domain.co',
            MONGO_OPLOG_URL: 'mongodb://oplogUser:mongo@domain.co'
        },
        ssl: { // Optional
            crt: '/fullpath/to/fullchain.pem',
            key: '/fullpath/to/privkey.pem',
            port: 443
        },
        logs: { //optional
             driver: 'syslog',
             opts: {
                 url:'udp://syslogserverurl.com:1234'
             }
        },
        // dockerImage: 'madushan1000/meteord-test', //optional, if you know what you're doing
        deployCheckWaitTime: 120 //default 10, if you're having issues try increasing this value up to 600
    },
    mongo: { //optional
        oplog: true,
        port: 27017,
        servers: {
            one: {},
        },
    },
};
```

--------------------------------

### Customize Docker image with app.docker.buildInstructions

Source: https://github.com/zodern/meteor-up/blob/master/docs/docs.md

Adds custom build instructions to the Docker image built during Prepare Bundle. Each item is added on a new line in the Dockerfile and should start with a Dockerfile instruction like RUN or USER. If the base image runs as a non-root user, switch to root for RUN commands and back afterwards.

```javascript
module.exports = {
  app: {
    name: 'app',
    path: '../',
    servers: { one: {} },
    docker: {
      buildInstructions: [
        'RUN apt-get update && apt-get install -y imagemagick'
      ]
    }
  }
};
```

--------------------------------

### show(overview)

Source: https://github.com/zodern/meteor-up/blob/master/_autodocs/api-reference/status.md

Prints the display tree.

```APIDOC
## `show(overview)`

### Description
Prints the display tree. In overview mode only depth-0 lines and non-`'green'` lines are printed.

### Parameters
- `overview` (boolean) - Required - `--overview` flag.

### Returns
- `undefined` - Prints a blank line then the tree with two-space indentation per depth.
```

--------------------------------

### utils.scrubUrl example

Source: https://github.com/zodern/meteor-up/blob/master/_autodocs/api-reference/scrub-config.md

Example of `utils.scrubUrl` anonymizing a URL: replaces auth with `user:pass@`, replaces the hostname with `subdomain.host.com`, and preserves port, path, and hash. The output is shown as a comment.

```javascript
// utils.scrubUrl('https://admin:s3cret@app.example.com:9443/api?q=1')
// => 'https://user:pass@subdomain.host.com:9443/api?q=1'
```

--------------------------------

### Plugin configuration in mup config

Source: https://github.com/zodern/meteor-up/blob/master/docs/plugins.md

Add a 'plugins' array to your Meteor Up config to use installed plugins. Plugins can be installed locally or globally via npm, and can be referenced by name or path.

```javascript
module.exports = {
  // ... rest of config

  plugins: ['name-of-plugin', 'name-of-other-plugin', '../path/to/plugin']
};
```

--------------------------------

### locatePluginDir(name, configPath, appPath)

Source: https://github.com/zodern/meteor-up/blob/master/_autodocs/api-reference/load-plugins.md

Resolves a plugin specifier to an absolute path. It tries several resolution strategies in order: path-like names, local to config folder, installed with mup, local to app folder, globally installed, and finally returns the name unchanged as a fallback.

```APIDOC
## locatePluginDir(name, configPath, appPath)

### Description
Resolves a plugin specifier to an absolute path. It tries several resolution strategies in order: path-like names, local to config folder, installed with mup, local to app folder, globally installed, and finally returns the name unchanged as a fallback.

### Parameters
- **name** (string) - Required - Plugin specifier: bare package name, relative/absolute path, or ~-tilde path.
- **configPath** (string) - Required - Path of the mup.js config file.
- **appPath** (string) - Required - Resolved path of the app (may be empty string when config.app is absent).

### Returns
- **string** - An absolute path to the plugin entry module.

### Resolution Order
1. Path-like names (starting with ., /, or ~): resolvePath(configPath, '../', name).
2. Locally to the config folder: resolveFrom.silent(configPath, name).
3. Installed with mup: require.resolve(name) (resolves relative to this package's node_modules).
4. Locally in the app folder: resolveFrom.silent(appPath, name).
5. Globally installed: resolveFrom.silent(resolve(globalModules, '..'), name) - uses the global-modules package.
6. Fallback: returns name unchanged (failure surfaces later in require).
```

--------------------------------

### mup deploy command

Source: https://github.com/zodern/meteor-up/wiki/Home

Command to deploy the Meteor app after setup.

```bash
mup deploy
```

--------------------------------

### init.js default export: init(api)

Source: https://github.com/zodern/meteor-up/blob/master/_autodocs/api-reference/default-plugin.md

Command handler for 'mup init'. Determines the destination folder based on the current working directory's contents, copies template files (mup.js.sample and settings.json) if they don't exist, and prints next steps.

```javascript
export default function init(api) { ... }    // init.js:38
```

--------------------------------

### Initialize Meteor Up project

Source: https://github.com/zodern/meteor-up/blob/master/docs/getting-started.md

Initializes a new Meteor Up project in a .deploy folder. Run from the app directory.

```shell
cd path/to/app
mkdir .deploy && cd .deploy
mup init
```

--------------------------------

### Configure SSL certificate upload in mup.js

Source: https://github.com/zodern/meteor-up/blob/master/docs/docs.md

Add this configuration to your mup.js file to upload your own SSL certificates. The crt and key fields specify the certificate bundle and private key paths. Run mup setup and mup deploy to apply the SSL setup. Add upload: false to prevent Mup from overriding existing server certificates.

```ts
app: {
  ...
  ssl: {
    crt: './bundle.crt', // this is a bundle of certificates
    key: './private.key', // this is the private key of the certificate
    port: 443 // 443 is the default value and it's the standard HTTPS port
  }
  ...
}

```

--------------------------------

### Sudo no tty error message

Source: https://github.com/zodern/meteor-up/blob/master/docs/docs.md

Error message that may appear when the NOPASSWD sudo setup is not working correctly.

```bash
'sudo: no tty present and no askpass program specified'
```

--------------------------------

### Example plugin module (my-plugin/index.js)

Source: https://github.com/zodern/meteor-up/blob/master/_autodocs/api-reference/plugin-modules.md

Defines a Meteor Up plugin module with a name, description, a 'status' command that runs 'docker.status', and hooks for validation, config preparation, scrubbing, and swarm options. The validation uses Joi to require a 'url' property, and the plugin is loaded via 'plugins: ["my-plugin"]' in mup.js.

```javascript
// my-plugin/index.js
module.exports = {
  name: 'my-plugin',
  description: 'Example plugin',
  commands: {
    status: {
      description: 'Show my status',
      handler(api) { return api.runCommand('docker.status'); }
    }
  },
  validate: {
    myPlugin: (config, { addLocation, combineErrorDetails, VALIDATE_OPTIONS }) => {
      const joi = require('@hapi/joi');
      const details = combineErrorDetails([], joi.validate(config.myPlugin, joi.object().keys({
        url: joi.string().required()
      }), VALIDATE_OPTIONS));
      return addLocation(details, 'myPlugin');
    }
  },
  prepareConfig(config) { config.myPlugin.url = config.myPlugin.url || 'http://localhost'; return config; },
  scrubConfig(config) { if (config.myPlugin) config.myPlugin.url = 'http://scrubbed'; return config; },
  swarmOptions(config) { if (config.myPlugin) return { labels: [{ name: 'my-label', value: 'true', servers: Object.keys(config.servers) }] }; }
};
```

--------------------------------

### Scaffold and validate with mup CLI

Source: https://github.com/zodern/meteor-up/blob/master/_autodocs/api-reference/default-plugin.md

Run these commands in a Meteor app directory to initialize a project with 'mup init', then validate the configuration. Use '--show' to print normalized config JSON after plugin prepareConfig, '--scrub' to print config with secrets scrubbed, and 'mup ssh one' to open an interactive shell on server 'one'.

```bash
cd my-meteor-app
mup init            # creates .deploy/mup.js + settings.json (or files in cwd)
cd .deploy
mup validate        # ✓ Config is valid
mup validate --show # prints normalized config JSON after plugin prepareConfig
mup validate --scrub # prints config with secrets scrubbed
mup ssh one         # interactive shell on server 'one'
```

--------------------------------

### Programmatic swarm helpers usage

Source: https://github.com/zodern/meteor-up/blob/master/_autodocs/api-reference/docker-plugin.md

Example of using swarm helpers from a plugin: diffLabels computes labels to add/remove, and updateLabels applies them.

```javascript
import { initSwarm, diffLabels, updateLabels } from './swarm';

const { toAdd, toRemove } = diffLabels(currentLabels, desiredLabels);
if (toAdd.length || toRemove.length) {
  await updateLabels(api, 'one', toAdd, toRemove);
}
```

--------------------------------

### View Let's Encrypt logs with docker logs

Source: https://github.com/zodern/meteor-up/blob/master/docs/docs.md

Command to view Let's Encrypt logs on the server. Replace <AppName> with the name of the app.

```bash
docker logs <AppName>-nginx-letsencrypt
```

--------------------------------

### getSettings()

Source: https://github.com/zodern/meteor-up/blob/master/docs/plugins.md

Returns the Meteor settings file, loading it if it hasn't been yet.

```APIDOC
## getSettings()

### Description
Returns the Meteor settings file, loading it if it hasn't been yet.

### Method
getSettings

### Parameters
None

### Returns
- **object** - The Meteor settings.
```

--------------------------------

### Fire-and-forget update check in CLI wrapper

Source: https://github.com/zodern/meteor-up/blob/master/_autodocs/api-reference/updates.md

Usage example from the CLI wrapper: calls checkUpdates with the current package and plugin list without awaiting the result.

```javascript
checkUpdates([
  { name: pkg.name, path: require.resolve('../package.json') },
  ...pluginList
]);
```

--------------------------------

### Add nested lines to StatusDisplay

Source: https://github.com/zodern/meteor-up/blob/master/_autodocs/api-reference/status.md

Example from meteor/command-handlers.js showing how to add nested lines to a StatusDisplay. addLine returns a Line node that can have child lines added to it.

```javascript
const section = display.addLine(`- ${host}: running`, 'green');
section.addLine(`Created at ${created}`);
const envSection = section.addLine('ENV:');
envSection.addLine(`- ${envVar}`);
```
Tokens:
Raw