hydrus/docs/update_guide.rtf

64 lines
7.5 KiB
Plaintext
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{\rtf1\ansi\ansicpg1252\deff0\nouicompat\deflang1033\deflangfe2052{\fonttbl{\f0\fswiss\fprq2\fcharset0 Arial;}{\f1\fnil\fcharset1 Cambria Math;}{\f2\fnil\fcharset2 Symbol;}}
{\colortbl ;\red0\green0\blue0;\red102\green102\blue102;\red255\green0\blue0;\red217\green217\blue217;\red0\green0\blue255;\red17\green85\blue204;}
{\stylesheet{ Normal;}{\s1 heading 1;}}
{\*\generator Riched20 10.0.15063}{\*\mmathPr\mmathFont1\mnaryLim0\mdispDef1\mwrapIndent1440 }\viewkind4\uc1
\pard\keep\keepn\widctlpar\sa60\sl276\slmult1\cf1\f0\fs52 Upgrade Guide\par
\pard\widctlpar\sl276\slmult1\fs22\par
\pard\keep\keepn\widctlpar\sa120\sl240\slmult1\cf2\fs24 Important highlights\par
\cf3 # Upgrading to or past version 335\fs30\par
\fs24 # General upgrade instructions\cf2\par
\pard\widctlpar\sl276\slmult1\cf1\fs22\par
\par
\par
\pard\keep\keepn\widctlpar\s1\sb400\sa120\sl276\slmult1\fs40 Hydrus upgrading - an introduction\par
\pard\widctlpar\sl276\slmult1\fs22 It is generally recommended to upgrade Hydrus to the latest version\par
\par
Hydrus\rquote upgrade process is very robust from one version to the next, and runs a cumulative upgrade process. The success of an upgrade may become less than ideal the further apart your current version is to the target version you upgrade to. It is recommended to upgrade no more than ten (10) version at a time. E.g. you should be fine upgrading directly from version 366 to version 376. Upgrading from, say, version 350 to version 376, however, is not supported and not recommended as it may cause problems.\par
\par
For clarity. Never upgrade more than 10 versions at a time. If you wish to update from version 350 to version 376, you should upgrade through this version path:\par
\pard{\pntext\f2\'B7\tab}{\*\pn\pnlvlblt\pnf2\pnindent360{\pntxtb\'B7}}\widctlpar\fi-360\li720\sl276\slmult1\tx360\tx720 350 \f1\u8658?\f0\lang1033 360\par
{\pntext\f2\'B7\tab}360 \f1\u8658?\f0\lang1033 370\par
{\pntext\f2\'B7\tab}370 \f1\u8658?\f0\lang1033 377\par
\pard\widctlpar\sl276\slmult1\par
To perform an upgrade, first close down your Hydrus client or server. Extract or run the installer to place the new files inside your Hydrus root/installation folder. The new files should overwrite all the old Hydrus client files that needs to be replaced for an update to take place. Launch the Hydrus client as normal to initiate the upgrade process. The client will indicate that an upgrade is in process and report back to the user once completed.\par
\par
Your actual file-collection, settings, tags and mappings - so forth - will not be overwritten. These are all safe inside the /db/ folder.\par
\par
Every computer system is different from the next, so there is no guarantee attached to upgrading. Any upgrade could fail. It is solely your responsibility to take good care and perform a backup of the important database files before you upgrade. Should any issues occur, you may contact the Hydrus Developer (dev) or get in touch with the community to seek help and assistance. Dev is very active on Twitter, Tumblr, various Channels and the Hydrus Discord server. The community is very active on the Hydrus Discord server. The dev joins the Discord twice a week. More information and links to all of these locations can be found on the \b\i help > contacts\b0\i0 page.\par
\pard\keep\keepn\widctlpar\s1\sb400\sa120\sl276\slmult1\fs40 Before you begin (1) - backup\par
\pard\widctlpar\sl276\slmult1\fs22 It is recommended that you perform a backup of your Hydrus database files before performing any form of Hydrus upgrade, despite any other recommendations from anyone. Despite how robust the upgrade process is, problematic issues may arise due to unforeseen circumstances and conditions outside of anyone\rquote s control.\par
\par
The following files, in no particular order, are critical and should always be backed up from time to time, and/or before a upgrade: \par
\pard{\pntext\f2\'B7\tab}{\*\pn\pnlvlblt\pnf2\pnindent360{\pntxtb\'B7}}\widctlpar\fi-360\li720\sl276\slmult1\tx360\tx720 client.caches.db\par
{\pntext\f2\'B7\tab}client.db\par
{\pntext\f2\'B7\tab}client.mappings.db\par
{\pntext\f2\'B7\tab}client.master.db\par
\pard\widctlpar\sl276\slmult1\par
\highlight4 TIP: These database files are located inside the /\b db\b0 / folder of your Hydrus root folder (where it is installed). Example: C:\\Hydrus\\db\\ or /home/hydrus/db/.\par
\highlight0\par
As a quick mention: by default, your actual files are located inside the /\b client_files\b0 / folder, a sub-folder of the /\b db\b0 /-folder. These files will never be touched nor damaged by an upgrade. This folder is usually very large, depending on your file collection, as these are the actual files. There is normally no need to back these up for an upgrade, but you may wish to include these with your regular backups to avoid data loss in case of a system or harddrive failure. The file-path can be changed by the user by performing a file migration. \b\i See the documentation on file migration for more information.\par
\b0\i0\par
\par
\pard\keep\keepn\widctlpar\s1\sb400\sa120\sl276\slmult1\fs40 Before you begin (2) - Version 335, the major Python2 \f1\u8658?\f0\lang1033 Python3 change\par
\pard\widctlpar\sl276\slmult1\b\fs22 Important!\b0 Version 335 introduces major changes that requires the user to follow special instructions in order to successfully upgrade the client. This is because of the major changes required to replace Python2 with Python3.\par
\par
Before you upgrade to, or through, version 335, read, understand and follow the steps that apply to your OS and installation type. All steps are clearly outlined inside the release post for version 335, which is found here: {{\field{\*\fldinst{HYPERLINK "https://hydrus.tumblr.com/post/181885931124/version-335"}}{\fldrslt{\ul\cf5\cf6\ul https}}}}{\f0\fs22{\field{\*\fldinst{HYPERLINK "https://hydrus.tumblr.com/post/181885931124/version-335"}}{\fldrslt{\ul\cf5\cf6\ul ://}}}}{\cf1\ulnone\f0\fs22{\field{\*\fldinst{HYPERLINK "https://hydrus.tumblr.com/post/181885931124/version-335"}}{\fldrslt{\ul\cf5\cf6\ul hydrus}}}}{\cf1\ulnone\f0\fs22{\field{\*\fldinst{HYPERLINK "https://hydrus.tumblr.com/post/181885931124/version-335"}}{\fldrslt{\ul\cf5\cf6\ul .}}}}{\cf1\ulnone\f0\fs22{\field{\*\fldinst{HYPERLINK "https://hydrus.tumblr.com/post/181885931124/version-335"}}{\fldrslt{\ul\cf5\cf6\ul tumblr}}}}{\cf1\ulnone\f0\fs22{\field{\*\fldinst{HYPERLINK "https://hydrus.tumblr.com/post/181885931124/version-335"}}{\fldrslt{\ul\cf5\cf6\ul .}}}}{\cf1\ulnone\f0\fs22{\field{\*\fldinst{HYPERLINK "https://hydrus.tumblr.com/post/181885931124/version-335"}}{\fldrslt{\ul\cf5\cf6\ul com}}}}{\cf1\ulnone\f0\fs22{\field{\*\fldinst{HYPERLINK "https://hydrus.tumblr.com/post/181885931124/version-335"}}{\fldrslt{\ul\cf5\cf6\ul /}}}}{\cf1\ulnone\f0\fs22{\field{\*\fldinst{HYPERLINK "https://hydrus.tumblr.com/post/181885931124/version-335"}}{\fldrslt{\ul\cf5\cf6\ul post}}}}{\cf1\ulnone\f0\fs22{\field{\*\fldinst{HYPERLINK "https://hydrus.tumblr.com/post/181885931124/version-335"}}{\fldrslt{\ul\cf5\cf6\ul /181885931124/}}}}{\cf1\ulnone\f0\fs22{\field{\*\fldinst{HYPERLINK "https://hydrus.tumblr.com/post/181885931124/version-335"}}{\fldrslt{\ul\cf5\cf6\ul version}}}}{\cf1\ulnone\f0\fs22{\field{\*\fldinst{HYPERLINK "https://hydrus.tumblr.com/post/181885931124/version-335"}}{\fldrslt{\ul\cf5\cf6\ul -335}}}}\cf1\ulnone\f0\fs22\par
\par
This release post applies to Hydrus on both Windows, Linux and Mac OS of any installation type: Installer, standalone/archive and source).\par
\par
This is very important. You must not skip this step for any reason.\par
}