mfahampshire
a336893116
* first pass redoc apis * new landing + component update * added intro * new structure * link list * add sandbox sdk * remove theme colours * revert credit to ticket & ticketbook and actually get all the instances to replace * Max/zknym doc tweak (#5223) * revert credit to ticket & ticketbook * revert credit to ticket & ticketbook and actually get all the instances to replace * theme tweak to widen text area * theme redoc component * tweak padding topbar * modified socks5 page to be in line with websocket client * modify h size of autodoc generated command info * tweak script to build from master * add autodoc to workspace * auto commit generated command files * clean autodoc-generated-markdown in script * auto commit generated command files * tweak works * clippy * fix borked toml from cherrypick * remove rm command * auto commit generated command files * blow away images * auto commit generated command files * remove redoc for nymapi for the moment but retain everything else * fix double paste * temp remove sandbox
30 lines
1.4 KiB
Plaintext
30 lines
1.4 KiB
Plaintext
# Configuring your client
|
||
When you initalise a client instance, a configuration directory will be generated and stored in `$HOME_DIR/.nym/socks5-clients/<client-name>/`.
|
||
|
||
```
|
||
tree $HOME/<user>/.nym/socks5-clients/docs-example
|
||
├── config
|
||
│ └── config.toml
|
||
└── data
|
||
├── ack_key.pem
|
||
├── credentials_database.db
|
||
├── gateway_shared.pem
|
||
├── persistent_reply_store.sqlite
|
||
├── private_encryption.pem
|
||
├── private_identity.pem
|
||
├── public_encryption.pem
|
||
└── public_identity.pem
|
||
|
||
```
|
||
|
||
The `config.toml` file contains client configuration options, while the two `pem` files contain client key information.
|
||
|
||
The generated files contain the client name, public/private keypairs, and gateway address. The name `<client_id>` in the example above is just a local identifier so that you can name your clients.
|
||
|
||
#### Configuring your client for Docker
|
||
By default, the native client listens to host `127.0.0.1`. However this can be an issue if you wish to run a client in a Dockerized environment, where it can be convenenient to listen on a different host such as `0.0.0.0`.
|
||
|
||
You can set this via the `--host` flag during either the `init` or `run` commands.
|
||
|
||
Alternatively, a custom host can be set in the `config.toml` file under the `socket` section. If you do this, remember to restart your client process.
|