Client Configuration

For Users

When you are logging in, your Synapse credentials can be stored using the rememberMe parameter. You should use the rememberMe feature only if you are on a personal computer where you are the only Synapse user. Visit the Python client docs and R client docs for examples.

For Developers

Customize the Synapse Configuration File

Synapse configuration parameters for frequently used client-interactions can be set in a configuration file. By default, the file is in the user’s home directory and is called .synapseConfig. For example, you can set:

• A new cache location

• Third party credentials to access files stored outside of Synapse (e.g. AWS-S3, etc.)

• Your Synapse credentials, preferably in the form of an access token

Note the period at the beginning of the file name that makes it a hidden system file on Linux-like operating systems, since it will contain sensitive information.

When you install the Synapse Python client, a .synapseConfig file filled with examples should appear in your home directory if a configuration file is not already present. You can uncomment and fill out the parameters of interest. A copy of the default .synapseConfig template can also be obtained here.

See the following for more information on managing credentials in the .synapseConfig

• Python / Command Line Client

• R client