All settings are stored in the .nexus/ folder within the repository checkout.
Configuration settings are used in customizing the Vagrant box. The defaults will satisfy most use cases, but if you really want to change them, you can.
To change a setting, use nexus config update. The setting's name should be passed as the 1st argument and the new value as the 2nd.
nexus config update ip 192.168.13.37For a list of customizable settings, use nexus config list, or view the help menu.
nexus config listA project is a website, or library, or simply a folder that will be synced into Vagrant. Once a project is synced, it will be available through nginx.
To add a project, use nexus project add. The project's source directory should be passed as the 1st argument.
nexus project add ~/Sites/FooBar/This command will sync your source directory to the Vagrant /home/vagrant/FooBar target directory. To change the target directory name, pass a 2nd argument to the command.
nexus project add ~/Sites/FooBar/ foo-barYou can customize the nginx hostname by passing a --hostname option to the command. If no option is passed, it will fallback to the target directory name + .app.
nexus project add ~/Sites/FooBar/ --hostname=foobar.appIf the root of the source directory is not the nginx public webroot, you can pass a relative path to the --webroot option.
nexus project add ~/Sites/FooBar/ --hostname=foobar.app --webroot=public/To list all defined projects, use nexus project list.
nexus project listTo delete a project, use nexus project delete and pass the hostname as its argument. If you do not know the hostname, use the list command above to find it.
nexus project delete foobar.appEnvironment variables are values that are available through getenv() within your PHP or Hack scripts. They are made available through HHVM's FastCGI layer.
To add or update a variable, use nexus var add. The variable key should be passed as the 1st argument, and the value as the 2nd. The APP_ENV variable is defined as local by default.
nexus var add APP_ENV localTo list all variables, use nexus var list.
nexus var listTo delete a variable, use nexus var delete and pass the variable key as its argument.
nexus var delete APP_ENVA database is simply that, a database. You can define a list of databases to be automatically created for MySQL and PostgreSQL.
To create a database, use nexus db add and pass the database name. Either the --mysql or --pgsql option should be passed, depending on which engine you want the database created in.
nexus db add foo --mysqlTo list all databases, use nexus db list.
nexus db listTo delete a database, use nexus db delete and pass the database name as its argument. Please note that this does not actually delete the database from MySQL or PostgreSQL, it simply removes the configuration.
nexus db delete fooThe user nexus, with password secret, can be used to connect to either databases.
There may be situations where you need to reuse a Nexus configuration across multiple users or computers. This can easily be achieved by importing and exporting the configuration files.
To export the current configuration, use nexus export. This will export all configuration files to ~/.nexus.
nexus exportTo import any configuration files found in ~/.nexus, use nexus import.
nexus importBoth of these commands will overwrite existing files, so be careful.
Once configuration has been modified, the Vagrant box will need to be provisioned. If it's the first time Vagrant is booted, use nexus up, else use nexus reload.
nexus upThe reload command is equivalent to vagrant reload --provision.
nexus reloadTo hook into the provisioning process, there are two scripts found in .nexus/ that can be modified. They are after-provision.sh and before-provision.sh.
Both of these scripts will be ran with bash when Vagrant is provisioned. They will also be exported and imported.