| 1 | How to Update SillyTavern |
| 2 | |
| 3 | The most recent version can be found here: https://docs.sillytavern.app/usage/update/ |
| 4 | |
| 5 | This is not an installation guide. If you need installation instructions, look here: |
| 6 | https://docs.sillytavern.app/installation/windows/ |
| 7 | |
| 8 | This guide assumes you have already installed SillyTavern once, and know how to run it on your OS. |
| 9 | |
| 10 | Linux/Termux: |
| 11 | |
| 12 | You definitely installed via git, so just 'git pull' inside the SillyTavern directory. |
| 13 | |
| 14 | Windows/MacOS: |
| 15 | |
| 16 | Method 1 - GIT |
| 17 | |
| 18 | We always recommend users install using 'git'. Here's why: |
| 19 | |
| 20 | When you have installed via `git clone`, all you have to do to update is type `git pull` in a command line in the ST folder. |
| 21 | You can also try running the 'UpdateAndStart.bat' file, which will almost do the same thing. (Windows only) |
| 22 | Alternatively, if the command prompt gives you problems (and you have GitHub Desktop installed), you can use the 'Repository' menu and select 'Pull'. |
| 23 | The updates are applied automatically and safely. |
| 24 | |
| 25 | If you are a developer and use a fork of ST or switch branches regularly, you can use the 'UpdateForkAndStart.bat', which works similarly to 'UpdateAndStart.bat', |
| 26 | but automatically pulls changes into your fork and handles switched branches gracefully by asking if you want to switch back. |
| 27 | |
| 28 | Method 2 - ZIP |
| 29 | |
| 30 | If you insist on installing via a zip, here is the tedious process for doing the update: |
| 31 | |
| 32 | 1. Download the new release zip. |
| 33 | 2. Unzip it into a folder OUTSIDE of your current ST installation. |
| 34 | 3. Do the usual setup procedure for your OS to install the NodeJS requirements. |
| 35 | |
| 36 | 4a. Updating 1.12.0 and above |
| 37 | |
| 38 | Copy the user data directory from your data root into the data root of the new install. |
| 39 | |
| 40 | By default: /data/default-user |
| 41 | |
| 42 | 4a. Migrating from <1.12.0 to >=1.20.0 |
| 43 | Copy the following files/folders as necessary(*) from your old ST installation: |
| 44 | |
| 45 | - Assets |
| 46 | - Backgrounds |
| 47 | - Characters |
| 48 | - Chats |
| 49 | - Context |
| 50 | - Groups |
| 51 | - Group chats |
| 52 | - Instruct |
| 53 | - movingUI |
| 54 | - KoboldAI Settings |
| 55 | - NovelAI Settings |
| 56 | - OpenAI Settings (Chat Completion API) |
| 57 | - TextGen Settings (Text Completion API) |
| 58 | - QuickReplies |
| 59 | - Themes |
| 60 | - User Avatars |
| 61 | - Worlds |
| 62 | - User |
| 63 | - settings.json |
| 64 | - secrets.json <---- This one is in the base folder, not /public/ |
| 65 | |
| 66 | (*) 'As necessary' = "If you made any custom content related to those folders". |
| 67 | None of the folders are mandatory, so only copy what you need. |
| 68 | |
| 69 | **NB: DO NOT COPY THE ENTIRE /PUBLIC/ FOLDER.** |
| 70 | Doing so could break the new install and prevent new features from being present. |
| 71 | Paste those items into the /data/default-user folder of the new install. |
| 72 | |
| 73 | 5. Start SillyTavern once again with the method appropriate to your OS, and pray you got it right. |
| 74 | |
| 75 | 6. If everything shows up, you can safely delete the old ST folder. |