docs/content/3.client/5.upgrade.md

71 lines
2.5 KiB
Markdown
Raw Normal View History

---
2024-03-22 16:16:19 +00:00
title: 'Update guide'
---
2023-12-31 14:39:55 +00:00
2024-03-22 16:16:19 +00:00
# Keeping your instance synced
Keeping your instance up-to-date with the latest features and bug fixes can enhance your instance's functionality and ensure it stays current. When updates are released, you have the option to adopt them using either one of the guides. Below, you willl find a manual and an automatic guide for updating your instance.
2024-03-22 16:16:19 +00:00
## Manual update
You can manually update by executing the following commands at the root of your instance:
2024-03-22 16:16:19 +00:00
```bash
git remote add movie-web https://github.com/movie-web/movie-web.git
git fetch movie-web
# Change `dev` to `master` if you want a stable experience
git merge movie-web/dev --allow-unrelated-histories
git push -f # Force push to your origin main branch
```
## Automatic update
You can also setup a scheduled workflow to automatically update your instance. This will allow you to keep your instance up to date without manual intervention.
To do this, you will need to follow the guide below...
1. Create a personal access token and add to repository's secret as `PAT`
2. Paste the below file into your repository's root `/.github/workflows` directory
```yaml
2024-03-23 00:45:11 +00:00
# File: .github/workflows/sync.yml
name: Sync fork
2024-03-22 16:16:19 +00:00
on:
schedule:
2024-03-23 00:45:11 +00:00
- cron: "*/5 * * * *"
push:
branches:
- "*"
paths:
- .github/workflows/sync.yml
2024-03-22 16:16:19 +00:00
jobs:
2024-03-23 00:45:11 +00:00
sync:
2024-03-22 16:16:19 +00:00
runs-on: ubuntu-latest
steps:
2024-03-23 00:45:11 +00:00
- uses: actions/checkout@v3
- run: gh repo sync reponame/forkname
env:
GH_TOKEN: ${{ github.token }}
- uses: gautamkrishnar/keepalive-workflow@v1
2024-03-22 16:16:19 +00:00
```
::alert{type="info"}
This workflow yaml file was taken from this [Github repository](https://github.com/repo-sync/github-sync).
::
3. Replace the source_repo, source_branch and destination_branch with the correct values for your repository.
4. Commit and push the changes to your repository.
Your instance should now be automatically updated to the latest version.
# Upgrade version
2023-12-12 23:08:31 +00:00
## From `3.X` to `4.X`
2023-12-12 21:27:15 +00:00
You will need the latest version of the proxy worker. Redeploy a new worker using [our self-hosting guide](../2.proxy/1.deploy.md).
After you have the new worker, you will need to [get the new movie-web deployment files](https://github.com/movie-web/movie-web/releases/latest). **You CANNOT use the non-PWA version**. To upgrade safely without any complications, you need to update with `movie-web.pwa.zip`, Not the non-PWA version.
In the future, you will **ALWAYS** need to go with the PWA option. You cannot downgrade to non-PWA version without facing many caching complications.