diff --git a/Updating-Zoraxy.md b/Updating-Zoraxy.md new file mode 100644 index 0000000..adda5e6 --- /dev/null +++ b/Updating-Zoraxy.md @@ -0,0 +1,35 @@ +## Update Zoraxy + +If you install Zoraxy natively on your host OS, here are the steps to update your Zoraxy to the latest version + +### Linux +Download and overwrite the binary file with the following command +``` +# Stop the service if running +sudo systemctl stop zoraxy + +# Navigate to the zoraxy installation path. If you build from source, it is usually under ~/zoraxy/src/ +cd ~/zoraxy/src +mv ./zoraxy ./zoraxy.backup + +# Download the new zoraxy release. Change the filename to a suitable architecture based on your hardware. +wget https://github.com/tobychui/zoraxy/releases/latest/download/zoraxy_linux_amd64 +mv ./zoraxy_linux_amd64 ./zoraxy +chmod +x ./zoraxy + +# Restart the zoraxy service +sudo systemctl start zoraxy +``` + +### Windows +If you are running Zoraxy on Windows, you can easily download and overwrite the executable. + +1. Rename the current version of `zoraxy.exe` to `zoraxy_backup.exe` +2. Download zoraxy from release page +3. Move the newly downloaded `zoraxy_windows_amd64.exe` to the original instllation path +4. Rename `zoraxy_windows_amd64.exe` to `zoraxy.exe` +5. Start the bat file (if any) or double click the zoraxy exe file. + +## IMPORTANT NOTES +- Note that each version might have some slight startup flag change. See change log and release notes for more information +- Always backup your config before update. Some version might contain breaking change that will alter your config files \ No newline at end of file