Skip to content

1.1 Configuration

sfloess edited this page Mar 5, 2013 · 1 revision

There are two ways to configure Solenopsis. Either with the python script or by editing/creating the configuration files by hand.

Wizard

If you have not run any solenopsis commands yet, you can just run solenopsis and it will walk you through the wizard to create your configuration files. If you want to add a new configuration you can run solenopsis config new credential

The table below explains the fields you will be asked to fill.

Prompt Definition
Please enter your environment name This is the human readable name that you provide to your environment. This will be used in other flags (such as -d) and must be alphanumeric with no spaces
Please enter your salesforce username This is the login for the Salesforce environment
Please enter your salesforce password This is the password for the Salesforce environment
Please enter your salesforce token This is token for the Salesforce environment
Is this a production instance? (Y/N) Is the salesforce environment a production or test environment

Configuration files

Primary configuration

The primary configuration file lives in ~/solenopsis.properties and has the following structure

solenopsis.ENVIRONMENTS=org1 org2 org3 local
solenopsis.env.HOME=/home/user/.solenopsis/
solenopsis.env.MASTER=local
solenopsis.env.DEPENDENT=org1
solenopsis.env.local.HOME=/home/user/org1/

sf.version = 26.0

sf.ignoreFile = /home/user/org1/.sfdcignore
Configuration Description
solenopsis.ENVIRONMENT A space separated list of environments we can use
solenopsis.env.HOME The folder that contains the credentials and environment cache
solenopsis.env.MASTER The master environment. Most of the time this will be `local`
solenopsis.env.DEPENDENT The dependent environment. This is where files will be pushed/pulled from by default
solenopsis.env.local.HOME The directory to which files will be pulled to
sf.version (OPTIONAL) The version of the Metadata API that you are using.
sf.ignoreFile (OPTIONAL) A file that lists out what should not be pushed/pulled from the environment

Credentials configuration

The sandbox credential configurations are stored in solenopsis.env.HOME/credentials/

username=USERNAME
password=PASSWORD
token=TOKEN
url=https://[test|login].salesforce.com
Configuration Description
username The salesforce username
password The salesforce password
token The salesforce token
url The base url for based on the environment type
Clone this wiki locally