Merge branch 'release' into staging

fba2d809d0f7cdd7bb5373d33d9d185a177d545c

Cohee <18619528+Cohee1207@users.noreply.github.com>

2 files changed, +28 -14Showing whitespace changes
.github/readme.md+27 -12
@@ -192,28 +192,43 @@ You will need two mandatory directory mappings and a port mapping to allow Silly
192192
193193##### Volume Mappings
194194
195195* [config]`CONFIG_PATH` - The directory where SillyTavern configuration files will be stored on your host machine
196196* [data]`DATA_PATH` - The directory where SillyTavern user data (including characters) will be stored on your host machine
197197* [plugins]`PLUGINS_PATH` - (optional) The directory where SillyTavern server plugins will be stored on your host machine
198198* [extensions]`EXTENSIONS_PATH` - (optional) The directory where global UI extensions will be stored on your host machine
199199
200200##### Port Mappings
201201
202202* [PublicPort]`PUBLIC_PORT` - The port to expose the traffic on. This is mandatory, as you will be accessing the instance from outside of its virtual machine container. DO NOT expose this to the internet without implementing a separate service for security.
203203
204204##### Additional Settings
205205
206-* [DockerNet] - The docker network that the container should be created with a connection to. If you don't know what it is, see the [official Docker documentation](https://docs.docker.com/reference/cli/docker/network/).
206+* `SILLYTAVERN_VERSION` - On the right-hand side of this GitHub page, you'll see "Packages". Select the "sillytavern" package and you'll see the image versions. The image tag "latest" will keep you up-to-date with the current release. You can also utilize "staging" that points to the nightly image the respective branch.
207-* [version] - On the right-hand side of this GitHub page, you'll see "Packages". Select the "sillytavern" package and you'll see the image versions. The image tag "latest" will keep you up-to-date with the current release. You can also utilize "staging" and "release" tags that point to the nightly images of the respective branches, but this may not be appropriate, if you are utilizing extensions that could be broken, and may need time to update.
208207
209208#### InstallRunning commandthe container
210209
2112101. Open your Command Line
212-2. Run the following command
211+2. Run the following command in a folder where you want to store the configuration and data files:
213212
214-`docker run --name='sillytavern' --net='[DockerNet]' -p '8000:8000/tcp' -v '[plugins]':'/home/node/app/plugins':'rw' -v '[config]':'/home/node/app/config':'rw' -v '[data]':'/home/node/app/data':'rw' -v '[extensions]':'/home/node/app/public/scripts/extensions/third-party':'rw' 'ghcr.io/sillytavern/sillytavern:[version]'`
213+```bash
214+SILLYTAVERN_VERSION="latest"
215+PUBLIC_PORT="8000"
216+CONFIG_PATH="./config"
217+DATA_PATH="./data"
218+PLUGINS_PATH="./plugins"
219+EXTENSIONS_PATH="./extensions"
220+
221+docker run \
222+ --name="sillytavern" \
223+ -p "$PUBLIC_PORT:8000/tcp" \
224+ -v "$CONFIG_PATH:/home/node/app/config:rw" \
225+ -v "$DATA_PATH:/home/node/app/data:rw" \
226+ -v "$EXTENSIONS_PATH:/home/node/app/public/scripts/extensions/third-party:rw" \
227+ -v "$PLUGINS_PATH:/home/node/app/plugins:rw" \
228+ ghcr.io/sillytavern/sillytavern:"$SILLYTAVERN_VERSION"
229+```
215230
216-> Note that 8000 is a default listening port. Don't forget to use an appropriate port if you change it in the config.
231+> By default the container will run in the foreground. If you want to run it in the background, add the `-d` flag to the `docker run` command.
217232
218233### Building the image yourself
219234
public/scripts/power-user.js+1 -2
@@ -4235,14 +4235,13 @@ $(document).ready(() => {
42354235 ],
42364236 callback: (args, value) => {
42374237 const force = isTrueBoolean(String(args?.force ?? false));
4238- value = String(value ?? '').trim();
42394238
42404239 // Skip processing if no value and not forced
42414240 if (!force && !value) {
42424241 return power_user.user_prompt_bias;
42434242 }
42444243
42454244 power_user.user_prompt_bias = String(value ?? '');
42464245 $('#start_reply_with').val(power_user.user_prompt_bias);
42474246 saveSettingsDebounced();
42484247