update readme with whitelist IP wildcard explainer

This commit is contained in:
RossAscends
2023-05-17 01:14:03 +09:00
parent caf6e0887a
commit 48e109beac

View File

@@ -136,8 +136,8 @@ Easy to follow guide with pretty pictures:
5. Open a Command Prompt inside that folder by clicking in the 'Address Bar' at the top, typing `cmd`, and pressing Enter. 5. Open a Command Prompt inside that folder by clicking in the 'Address Bar' at the top, typing `cmd`, and pressing Enter.
6. Once the black box (Command Prompt) pops up, type ONE of the following into it and press Enter: 6. Once the black box (Command Prompt) pops up, type ONE of the following into it and press Enter:
* for Main Branch: `git clone https://github.com/Cohee1207/SillyTavern -b main` * for Main Branch: `git clone https://github.com/Cohee1207/SillyTavern -b main`
* for Dev Branch: `git clone https://github.com/Cohee1207/SillyTavern -b dev` * for Dev Branch: `git clone https://github.com/Cohee1207/SillyTavern -b dev`
7. Once everything is cloned, double click `Start.bat` to make NodeJS install its requirements. 7. Once everything is cloned, double click `Start.bat` to make NodeJS install its requirements.
8. The server will then start, and SillyTavern will popup in your browser. 8. The server will then start, and SillyTavern will popup in your browser.
@@ -179,13 +179,23 @@ However, it can be used to allow remote connections from anywhere as well.
* Create a new text file inside your SillyTavern base install folder called `whitelist.txt`. * Create a new text file inside your SillyTavern base install folder called `whitelist.txt`.
* Open the file in a text editor, add a list of IPs you want to be allowed to connect. * Open the file in a text editor, add a list of IPs you want to be allowed to connect.
*IP ranges are not accepted. Each IP must be listed individually like this:* *Both indidivual IPs, and wildcard IP ranges are accepted. Examples:*
```txt ```txt
192.168.0.1 192.168.0.1
192.168.0.2 192.168.0.20
192.168.0.3
192.168.0.4
``` ```
or
```txt
192.168.0.*
```
(the above wildcard IP range will allow any device on the local network to connect)
CIDR masks are also accepted (eg. 10.0.0.0/24).
* Save the `whitelist.txt` file. * Save the `whitelist.txt` file.
* Restart your TAI server. * Restart your TAI server.