# Proton

## Setup

*requires v1.2.7*

The following credentials keys are accepted:

* `host` **(required)** -> The hostname / ip of the instance
* `database` **(required)** -> The database name of the instance
* `user` (optional) -> The username to access the instance
* `schema` (optional) -> The default schema to use
* `password` (optional) -> The password to access the instance
* `port` (optional) -> The port of the instance. Default is `8463`.
* `ssh_tunnel` (optional) -> The URL of the SSH server you would like to use as a tunnel (example `ssh://user:password@db.host:22`)
* `ssh_private_key` (optional) -> The private key to use to access a SSH server (raw string or path to file).
* `ssh_passphrase` (optional) -> The passphrase to use to access a SSH server.

### Using `sling conns`

Here are examples of setting a connection named `PROTON`. We must provide the `type=proton` property:

{% code overflow="wrap" %}

```bash
$ sling conns set PROTON type=proton host=<host> user=<user> database=<database> password=<password> port=<port> 

# OR use url
$ sling conns set PROTON url="proton://myuser:mypass@host.ip:8463/mydatabase"

```

{% endcode %}

### Environment Variable

See [here](https://docs.slingdata.io/sling-cli/environment#dot-env-file-.env.sling) to learn more about the `.env.sling` file.

{% code overflow="wrap" %}

```bash
export PROTON='proton://myuser:mypass@host.ip:8463/mydatabase'
export PROTON='{ type: proton, user: "myuser", password: "mypass", host: "host.ip", port: 8463, database: "mydatabase" }'
```

{% endcode %}

### Sling Env File YAML

See [here](https://docs.slingdata.io/sling-cli/environment#sling-env-file-env.yaml) to learn more about the sling `env.yaml` file.

```yaml
connections:
  PROTON:
    type: proton
    host: <host>
    user: <user>
    port: <port>
    database: <database>
    schema: <schema>
    password: <password>

  PROTON_URL:
    url: "proton://myuser:mypass@host.ip:8463/mydatabase"
```

If you are facing issues connecting, please reach out to us at <support@slingdata.io>, on [discord](https://discord.gg/q5xtaSNDvp) or open a Github Issue [here](https://github.com/slingdata-io/sling-cli/issues).