Nanobox configuration settings can be modified using the
nanobox config command. The first time any
nanobox command is run, Nanobox will automatically walk you through this process.
# View config settings nanobox config ls # Set a specific setting nanobox config set ram 4 # Get the value of a specific setting nanobox config get cpu
Changes to config settings require you to restart your Nanobox VM in order to be applied.
provider: docker-machine ci-mode: false mount-type: netfs cpus: 2 ram: 2 disk: 30000 netfs-mount-opts: # Advanced external-network-space: 192.168.99.50/24 docker-machine-network-space: 172.19.0.1/16 native-network-space: 172.18.0.1/16 ssh-key: default ssh-encrypted-keys: false anonymous: false lock-port: 12345 ci-sync-verbose: false
provider config defines which technology is used to manage Docker containers in your virtual/local host. The following providers are available:
docker_machine- Uses VirtualBox for virtualization and Docker Machine to create Docker containers in the VM.
native- Uses native docker containers on your host OS.
Continuous integration (CI) mode disables the Nanobox output summarizer and essentially runs Nanobox in verbose mode. Most CI services include their own output summarizers which can conflict with summarized output from other tools.
mount-type specifies which technology to use when mounting code on your local machine into Nanobox. The following options are available:
native- Uses the network file system native to your provider.
netfs- Uses NFS on OSX and Linux, CIFS on Windows. Much better performance, but requires admin permissions. Netfs is only used with the "docker_machine" provider.
cpu setting defines the number of CPU cores to make available to your virtualized environment.
ram setting defines the amount of RAM (in GB) to make available to your virtualized environment.
disk setting specifies the amount of disk space in MB to allot to your virtualized environment.
Note: The disk available to the VM cannot be changed on the fly. To modify the size of your Nanobox VM, you will need to implode the existing VM and recreate it after changing the disk setting in your config.
NetFS Mount Options
netfs_mount_opts specifies options to include when mounting your local codebase into Nanobox.
mfsymlinks- When running Nanobox in Windows, this option allows symlinks created in Nanobox to function properly with your local filesystem. There are caveats with this setting that are outlined in the Symlinks in Windows doc.
External Network Space
external-network-space defines the network that Nanobox creates to communicate with the containers from the outside, through a Virtual Private Network (VPN).
Docker Machine Network Space
docker-machine-network-space defines the network Nanobox uses to facilitate communication between Docker containers when using the "docker-machine" provider.
Native Network Space
native-network-space defines the network Nanobox uses to facilitate communication between Docker containers when using the "native" provider.
ssh-key defines a specific key for Nanobox to use when establishing SSH connections to remote servers. By default, Nanobox copies in all keys in your
SSH Encrypted Keys
ssh-encrypted-keys tells Nanobox whether or not to use password-protected SSH keys. By default, Nanobox will ignore password-protected keys. If enabled, you will be prompted for your SSH key password each time your applications build.
anonymous opts out of connecting your Nanobox CLI to your Nanobox account and have any error report sent to Nanobox. In order to interact with live apps, you will still need to authenticate your Nanobox account.
lock-port defines which port will be locked by tcp. This is necessary to prevent race conditions within Nanobox. If the specified port is already in use, it needs to be updated.
CI Sync Verbose
ci-sync-verbose defines whether or not
rsync logs are output when
ci-mode is set to
rsync logs aren't necessary so the this is set to
false by default, but enabling
rysnc logs can help when troubleshooting deployments from a continuous integration provider.
Reach out to email@example.com and we'll try to help.