rixty/SillyTavern
1
0
Fork 0
mirror of https://github.com/SillyTavern/SillyTavern.git synced 2025-06-05 21:59:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update readme.md Remote Connections Instructions

Browse Source
This commit is contained in:
RossAscends
2023-05-14 23:24:26 +09:00
committed by GitHub
parent 50ab9df54a
commit 3b0d0b580a
1 changed files with 36 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
readme.md
View File

@@ -168,45 +168,58 @@ In order to enable viewing your keys by clicking a button in the API block:
## Remote connections ## Remote connections
Most often this is for people who want to use SillyTavern on their mobile phones while at home. Most often this is for people who want to use SillyTavern on their mobile phones while their PC runs the ST server on the same wifi network.
If you want to enable other devices to connect to your TAI server, open 'config.conf' in a text editor, and change:
``` However, it can be used to allow remote connections from anywhere as well.
const whitelistMode = true;
```
to **IMPORTANT: SillyTavern is a single-user program, so anyone who logs in will be able to see all characters and chats, and be able to change any settings inside the UI.**
``` ### 1. Managing whitelisted IPs
const whitelistMode = false;
```
Save the file. * Create a new text file inside your SillyTavern base install folder called `whitelist.txt`.
Restart your TAI server. * Open the file in a text editor, add a list of IPs you want to be allowed to connect.
You will now be able to connect from other devices.
### Managing whitelisted IPs
You can add or remove whitelisted IPs by editing the `whitelist` array in `config.conf`. You can also provide a `whitelist.txt` file in the same directory as `config.conf` with one IP address per line like:
*IP ranges are not accepted. Each IP must be listed individually like this:*
```txt ```txt
192.168.0.1 192.168.0.1
192.168.0.2 192.168.0.2
192.168.0.3
192.168.0.4
``` ```
* Save the `whitelist.txt` file.
* Restart your TAI server.
The `whitelist` array in `config.conf` will be ignored if `whitelist.txt` exists. Now devices which have the IP specified in the file will be able to connect.
***Disclaimer: Anyone else who knows your IP address and TAI port number will be able to connect as well*** *Note: `config.conf` also has a `whitelist` array, which you can use in the same way, but this array will be ignored if `whitelist.txt` exists.*
To connect over wifi you'll need your PC's local wifi IP address ### 2. Connecting to ST from a remote device
* (For Windows: windows button > type 'cmd.exe' in the search bar> type 'ipconfig' in the console, hit Enter > "IPv4" listing) After the whitelist has been setup, to connect over wifi you'll need the IP of the ST-hosting device.
if you want other people on the internet to connect, check [here](https://whatismyipaddress.com/) for 'IPv4'
If the ST-hosting device is on the same wifi network, you will point your remote device's browser to the ST-host's internal wifi IP:
* For Windows: windows button > type `cmd.exe` in the search bar > type `ipconfig` in the console, hit Enter > look for `IPv4` listing.
If you (or someone else) wants to connect to your hosted ST while not being on the same network, you will need the public IP of your ST-hosting device.
While using the ST-hosting device, access [this page](https://whatismyipaddress.com/) and look for for `IPv4`. This is what you would use to connect from the remote device.
### Opening your ST to all IPs
We do not reccomend doing this, but you can open `config.conf` and change `whitelist` to `false`.
You must remove (or rename) `whitelist.txt` in the SillyTavern base install folder, if it exists.
This is usually an insecure practice, so we require you to set a username and password when you do this.
The username and password are set in `config.conf`.
After restarting your ST server, any device will be able to connect to it, regardless of their IP as long as they know the username and password.
### Still Unable To Connect? ### Still Unable To Connect?
- Create an inbound/outbound firewall rule for the port found in `config.conf`. Do NOT mistake this for portforwarding on your router, otherwise someone could find your chat logs and that's a big no-no. * Create an inbound/outbound firewall rule for the port found in `config.conf`. Do NOT mistake this for portforwarding on your router, otherwise someone could find your chat logs and that's a big no-no.
* Enable the Private Network profile type in Settings > Network and Internet > Ethernet. This is VERY important for Windows 11, otherwise you would be unable to connect even with the aforementioned firewall rules. * Enable the Private Network profile type in Settings > Network and Internet > Ethernet. This is VERY important for Windows 11, otherwise you would be unable to connect even with the aforementioned firewall rules.
## Performance issues? ## Performance issues?