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

Browse Source
This commit is contained in:
Cohee
2025-02-26 20:45:14 +02:00
parent 02cdec5a10
commit 7c7de3d965
1 changed files with 47 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
.github/readme.md vendored
View File

@ -317,29 +317,34 @@ Start.bat --port 8000 --listen false
### Supported arguments ### Supported arguments
| Option | Description | Type | > \[!TIP]
|-------------------------|------------------------------------------------------------------------------------------------------|----------| > None of the arguments are required. If you don't provide them, SillyTavern will use the settings in `config.yaml`.
| `--version` | Show version number | boolean |
| `--enableIPv6` | Enables IPv6. | boolean | | Option | Description | Type |
| `--enableIPv4` | Enables IPv4. | boolean | |-------------------------|----------------------------------------------------------------------|----------|
| `--port` | Sets the port under which SillyTavern will run. If not provided falls back to yaml config 'port'. | number | | `--version` | Show version number | boolean |
| `--dnsPreferIPv6` | Prefers IPv6 for dns. If not provided falls back to yaml config 'preferIPv6'. | boolean | | `--dataRoot` | Root directory for data storage | string |
| `--autorun` | Automatically launch SillyTavern in the browser. If not provided falls back to yaml config 'autorun'.| boolean | | `--port` | Sets the port under which SillyTavern will run | number |
| `--autorunHostname` | The autorun hostname, probably best left on 'auto'. | string | | `--listen` | SillyTavern will listen on all network interfaces | boolean |
| `--autorunPortOverride` | Overrides the port for autorun. | string | | `--whitelist` | Enables whitelist mode | boolean |
| `--listen` | SillyTavern is listening on all network interfaces. If not provided falls back to yaml config 'listen'.| boolean | | `--basicAuthMode` | Enables basic authentication | boolean |
| `--corsProxy` | Enables CORS proxy. If not provided falls back to yaml config 'enableCorsProxy'. | boolean | | `--enableIPv4` | Enables IPv4 protocol | boolean |
| `--disableCsrf` | Disables CSRF protection | boolean | | `--enableIPv6` | Enables IPv6 protocol | boolean |
| `--ssl` | Enables SSL | boolean | | `--listenAddressIPv4` | Specific IPv4 address to listen to | string |
| `--certPath` | Path to your certificate file. | string | | `--listenAddressIPv6` | Specific IPv6 address to listen to | string |
| `--keyPath` | Path to your private key file. | string | | `--dnsPreferIPv6` | Prefers IPv6 for DNS | boolean |
| `--whitelist` | Enables whitelist mode | boolean | | `--ssl` | Enables SSL | boolean |
| `--dataRoot` | Root directory for data storage | string | | `--certPath` | Path to your certificate file | string |
| `--avoidLocalhost` | Avoids using 'localhost' for autorun in auto mode. | boolean | | `--keyPath` | Path to your private key file | string |
| `--basicAuthMode` | Enables basic authentication | boolean | | `--autorun` | Automatically launch SillyTavern in the browser | boolean |
| `--requestProxyEnabled` | Enables a use of proxy for outgoing requests | boolean | | `--autorunHostname` | Autorun hostname | string |
| `--requestProxyUrl` | Request proxy URL (HTTP or SOCKS protocols) | string | | `--autorunPortOverride` | Overrides the port for autorun | string |
| `--requestProxyBypass` | Request proxy bypass list (space separated list of hosts) | array | | `--avoidLocalhost` | Avoids using 'localhost' for autorun in auto mode | boolean |
| `--corsProxy` | Enables CORS proxy | boolean |
| `--requestProxyEnabled` | Enables a use of proxy for outgoing requests | boolean |
| `--requestProxyUrl` | Request proxy URL (HTTP or SOCKS protocols) | string |
| `--requestProxyBypass` | Request proxy bypass list (space separated list of hosts) | array |
| `--disableCsrf` | Disables CSRF protection (NOT RECOMMENDED) | boolean |
## Remote connections ## Remote connections
@ -351,10 +356,29 @@ You may also want to configure SillyTavern user profiles with (optional) passwor
## Performance issues? ## Performance issues?
### General tips
1. Disable the Blur Effect and enable Reduced Motion on the User Settings panel (UI Theme toggles category). 1. Disable the Blur Effect and enable Reduced Motion on the User Settings panel (UI Theme toggles category).
2. If using response streaming, set the streaming FPS to a lower value (10-15 FPS is recommended). 2. If using response streaming, set the streaming FPS to a lower value (10-15 FPS is recommended).
3. Make sure the browser is enabled to use GPU acceleration for rendering. 3. Make sure the browser is enabled to use GPU acceleration for rendering.
### Input lag
Performance degradation, particularly input lag, is most commonly attributed to browser extensions. Known problematic extensions include:
* iCloud Password Manager
* DeepL Translation
* AI-based grammar correction tools
* Various ad-blocking extensions
If you experience performance issues and cannot identify the cause, or suspect an issue with SillyTavern itself, please:
1. [Record a performance profile](https://developer.chrome.com/docs/devtools/performance/reference)
2. Export the profile as a JSON file
3. Submit it to the development team for analysis
We recommend first testing with all browser extensions and third-party SillyTavern extensions disabled to isolate the source of the performance degradation.
## License and credits ## License and credits
**This program is distributed in the hope that it will be useful, **This program is distributed in the hope that it will be useful,