update docs

README.md

@@ -21,7 +21,7 @@ The following features are supported:
 
 **AIM**
 
-- [x] Windows AIM Clients: v1.x, v2.x, v3.x, v4.x, [v5.x](./docs/CLIENT.md), [v6.0-v6.5.3.12](./docs/AIM6.md)
+- [x] Windows AIM Clients: [v1.x-v5.x](./docs/CLIENT.md), [v6.x-v7.x](docs/AIM_6_7.md)
 - [x] Away Messages
 - [x] Buddy Icons (v4.x, v5.x)
 - [x] Buddy List

docs/AIM6.md → docs/AIM_6_7.md

@@ -58,8 +58,9 @@ To point the client to your Retro AIM Server:
    ```
 3. Set the file filter to **All Files**.
 4. Open `serviceManifest.xml`.
-5. Find the `aol.aimcc.connect.host.address` preference and update it to match your `OSCAR_HOST` Retro AIM Server
-   config:
+5. Find the `aol.aimcc.connect.host.address` preference and update it to match the hostname from your
+   `OSCAR_ADVERTISED_LISTENERS_PLAIN` Retro AIM Server config. For example, if
+   `OSCAR_ADVERTISED_LISTENERS_PLAIN=LOCAL://127.0.0.1:5190`, use `127.0.0.1`.
 
    ```diff
    -<preferenceDefault key="aol.aimcc.connect.host.address" scope="identity" type="string">login.oscar.aol.com</preferenceDefault>

docs/CLIENT.md

@@ -49,8 +49,9 @@ Once installed, configure AIM to connect to Retro AIM Server.
    <p>
       <img width="662" alt="screenshot of AIM preferences window" src="https://github.com/mk6i/mkdb/assets/2894330/c7cfcaa4-8132-4b57-b5c9-7643c99cbda2">
    </p>
-3. In the `Host` field, enter the value of `OSCAR_HOST` found in `config/settings`. In the `Port` field, enter the
-   value of `AUTH_PORT` found in `config/settings.env`.
+3. Configure the server host and port fields according to the `OSCAR_ADVERTISED_LISTENERS_PLAIN` configuration found in
+   `config/settings.env`. For example, if `OSCAR_ADVERTISED_LISTENERS_PLAIN=LOCAL://127.0.0.1:5190`, set `Host` to
+   `127.0.0.1` and `Port` to `5190`.
    <p>
       <img width="618" alt="screenshot of AIM host dialog" src="https://github.com/mk6i/mkdb/assets/2894330/da17c457-a773-4b82-b4ba-cb81f9a2e085">
    </p>

docs/CLIENT_ICQ.md

@@ -148,8 +148,9 @@ Server's hostname in the Windows Registry.
 3. **Configure OSCAR Host**
 
     - Double-click the `Default Server Host` registry entry.
-    - Set `Value data` to the value of `OSCAR_HOST` found in Retro AIM Server
-      configuration `config/settings.env`.
+    - Set `Value data` to the hostname from `OSCAR_ADVERTISED_LISTENERS_PLAIN` found in Retro AIM Server
+      configuration `config/settings.env`. For example, if `OSCAR_ADVERTISED_LISTENERS_PLAIN=LOCAL://127.0.0.1:5190`, use
+      `127.0.0.1`.
     - Click OK.
 
    <p align="center">
@@ -163,7 +164,8 @@ Server's hostname in the Windows Registry.
 
     - Double-click the `Default Server Port` registry entry.
     - Tick the `Decimal` radio button.
-    - Set `Value data` to the value of `AUTH_PORT` found in Retro AIM Server configuration `config/settings.env`.
+    - Set `Value data` to the port number from `OSCAR_ADVERTISED_LISTENERS_PLAIN` found in Retro AIM Server configuration
+      `config/settings.env`. For example, if `OSCAR_ADVERTISED_LISTENERS_PLAIN=LOCAL://127.0.0.1:5190`, use `5190`.
     - Click OK.
 
    <p align="center">

docs/DOCKER.md

@@ -71,7 +71,7 @@ Replace `ras.dev` with the hostname clients will use to connect.
 
 #### Certificate Database
 
-Follow the [AIM 6.x client setup instructions](AIM6.md#aim-6265312-setup) to install the `certs/nss/` database on each
+Follow the [AIM 6.x client setup instructions](AIM_6_7.md#aim-6265312-setup) to install the `certs/nss/` database on each
 client.
 
 #### Resolving Hostname

docs/LINUX.md

@@ -9,11 +9,17 @@ This guide explains how to download, configure and run Retro AIM Server on Linux
 
 2. **Configure Server Address**
 
-   Set `OSCAR_HOST` in `settings.env` to a hostname that AIM clients can connect to. The default setting is `127.0.0.1`,
-   which is enough to connect clients on the same PC.
+   Set the default listener in `OSCAR_ADVERTISED_LISTENERS_PLAIN` in `settings.env` to a hostname and port that the AIM
+   clients can connect to. If you are running the AIM client and server on the same machine, you don't need to change
+   the default value.
+
+   The format is `[NAME]://[HOSTNAME]:[PORT]` where:
+    - `LOCAL` is the listener name (can be any name you choose, as long as it matches the `OSCAR_LISTENERS` config)
+    - `127.0.0.1` is the hostname clients connect to
+    - `5190` is the port number clients connect to
 
    In order to connect AIM clients on your LAN (including VMs with bridged networking), you can find the appropriate IP
-   address by running `ifconfig` from the terminal
+   address by running `ifconfig` from the terminal and use that IP instead of `127.0.0.1`.
 
 3. **Start the Application**
 
@@ -28,8 +34,8 @@ This guide explains how to download, configure and run Retro AIM Server on Linux
 4. **Configure AIM Clients**
 
    To do a quick sanity check, start an AIM client, sign in to the server, and send yourself an instant message.
-   Configure the AIM client to connect to the host set in `OSCAR_HOST` in `settings.env`. (If you didn't change the
-   config, the address is `127.0.0.1`.)
+   Configure the AIM client to connect to the host and port from `OSCAR_ADVERTISED_LISTENERS_PLAIN` in `settings.env`. If
+   using the default server setting, set host to `127.0.0.1` and port `5190`.
 
    See the [Client Configuration Guide](./CLIENT.md) for more detail on setting up the AIM client.
 

docs/MACOS.md

@@ -42,11 +42,17 @@ This guide explains how to download, configure and run Retro AIM Server on macOS
 
 4. **Configure Server Address**
 
-   Set `OSCAR_HOST` in `settings.env` to a hostname that AIM clients can connect to. The default setting is `127.0.0.1`,
-   which is enough to connect clients on the same machine.
+   Set the default listener in `OSCAR_ADVERTISED_LISTENERS_PLAIN` in `settings.env` to a hostname and port that the AIM
+   clients can connect to. If you are running the AIM client and server on the same machine, you don't need to change
+   the default value.
+
+   The format is `[NAME]://[HOSTNAME]:[PORT]` where:
+    - `LOCAL` is the listener name (can be any name you choose, as long as it matches the `OSCAR_LISTENERS` config)
+    - `127.0.0.1` is the hostname clients connect to
+    - `5190` is the port number clients connect to
 
    In order to connect AIM clients on your LAN (including VMs with bridged networking), you can find the appropriate IP
-   address by running the following command in the terminal:
+   address by running the following command in the terminal and use that IP instead of `127.0.0.1`:
 
    ```shell
    osascript -e "IPv4 address of (system info)"
@@ -65,8 +71,7 @@ This guide explains how to download, configure and run Retro AIM Server on macOS
 6. **Test**
 
    To do a quick sanity check, start an AIM client, sign in to the server, and send yourself an instant message.
-   Configure the AIM client to connect to the host set in `OSCAR_HOST` in `settings.env`. (If you didn't change the
-   config, the address is `127.0.0.1`.)
+   Configure the AIM client to connect to the host and port from `OSCAR_ADVERTISED_LISTENERS_PLAIN` in `settings.env`. If using the default server setting, set host to `127.0.0.1` and port `5190`.
 
    See the [Client Configuration Guide](./CLIENT.md) for more detail on setting up the AIM client.
 

docs/WINDOWS.md

@@ -9,11 +9,17 @@ This guide explains how to download, configure and run Retro AIM Server on Windo
 
 2. **Configure Server Address**
 
-   Open `settings.env` (right-click, `edit in notepad`) and set `OSCAR_HOST` to a hostname that AIM clients can connect
-   to. The default setting is `127.0.0.1`, which is enough to connect clients on the same PC.
+   Open `settings.env` (right-click, `edit in notepad`) and set the default listener in `OSCAR_ADVERTISED_LISTENERS_PLAIN` to
+   a hostname and port that the AIM clients can connect
+   to. If you are running the AIM client and server on the same machine, you don't need to change the default value.
+
+   The format is `[NAME]://[HOSTNAME]:[PORT]` where:
+    - `LOCAL` is the listener name (can be any name you choose, as long as it matches the `OSCAR_LISTENERS` config)
+    - `127.0.0.1` is the hostname clients connect to
+    - `5190` is the port number clients connect to
 
    In order to connect AIM clients on your LAN (including VMs with bridged networking), you can find the appropriate IP
-   address by running `ipconfig` from the Command Prompt.
+   address by running `ipconfig` from the Command Prompt and use that IP instead of `127.0.0.1`.
 
 3. **Start the Application**
 
@@ -41,8 +47,8 @@ This guide explains how to download, configure and run Retro AIM Server on Windo
 4. **Test**
 
    To do a quick sanity check, start an AIM client, sign in to the server, and send yourself an instant message.
-   Configure the AIM client to connect to the host set in `OSCAR_HOST` in `settings.env`. (If you didn't change the
-   config, the address is `127.0.0.1`.)
+   Configure the AIM client to connect to the host and port from `OSCAR_ADVERTISED_LISTENERS_PLAIN` in `settings.env`. If
+   using the default server setting, set host to `127.0.0.1` and port `5190`.
 
    See the [Client Configuration Guide](./CLIENT.md) for more detail on setting up the AIM client.