Configuration

User configuration

Currently, configuration values are handled using environment variables that are managed in the config.json file that is generated on first run. It can be found in one of the following locations:

• Linux: ~/.config/sockchat/config.json

• macOS: ~/Library/Application Support/sockchat/config.json

• Windows: %APPDATA%\sockchat\config.json

Your config file will be automatically updated with any new configuration variables that may be added over time. I use sane defaults in the generated config that get you up and running right away, but it's important to know what they do:

• host: This is the domain name of the site we connect to (i.e. the Farms). Due to various annoying factors, this may be subject to a lot of change. If you can't connect, make sure you have this set to the current domain. If you set this to the .onion address, you will be connected over Tor. See below for more information.

• port: This is the port used for the chat's WebSocket connections. If you don't know what that means, don't worry; you will likely never need to modify this value.

• logger: Set this to true to enable chat logging.

• read_only: Set this to true to enable a read-only mode that prevents accidentally sending messages when lurking or logging. This completely disables the input field and its Shift+Tab toggle.

• room: This is the room that is automatically joined when first connecting. They are numbered a bit nonsensically, with 1 being General Chat. You can always switch rooms without reconnecting by manually sending a /join ID_HERE message with your desired room ID.

• tor: Set this to true to connect using the Tor network. This option is useful for routing clearnet traffic over Tor.

  • Tor is able to route clearnet traffic when normal DNS resolution isn't working. This comes in handy if yet another registrar, NIC, or Cogent decide to play Internet police.

  • Note that the domain value of host is used to connect when using Tor. Set it to the .onion domain if you want to connect through the Tor hidden service.

  • If host is set to a .onion domain, Tor is used regardless of the value of tor.

• user_id: Set this to your numerical user ID to help with recognizing mentions/replies to your messages.

  • The default value is -1, which signifies an unset ID. Setting this to any negative integer value achieves the same result. The client will work just fine if you leave it unset but you won't get your mentions highlighted.

  • If you don't know what your numerical ID is, go to your profile page on the Farms and look at the URL.
    The profile page URLs are formatted as such: /members/YOUR_USERNAME.YOUR_ID/. The integer value where YOUR_ID should be is your user ID.