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 is a automatic and an manual guide on updating your instance.

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...

This upgrade method will only work if your repository is a fork!

If you have not already, click here to fork the sudo-flix Github repository.

Paste the below file into your repository's root /.github/workflows directory

# File: .github/workflows/sync.yml
name: Sync fork
  contents: write
    - cron: "0 0 * * *"
    name: Sync fork
    runs-on: ubuntu-latest
    if: ${{ github.event.repository.fork }}
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Sync fork
        run: gh repo sync ${{ github.repository }}
          GH_TOKEN: ${{ github.token }}
      - uses: gautamkrishnar/keepalive-workflow@v1

Commit and push the changes to your repository.

Your instance should now be automatically updated to the latest version.

Manual update#

You can manually update by executing the following commands in the root directory of the repository you have created, you would have to do this every time a push occurs to stay up-to-date:

git remote add sudo-flix
git fetch sudo-flix
# Change `dev` to `master` if you want a stable experience
git merge sudo-flix/dev --allow-unrelated-histories
git push -f # Force push to your origin main branch

Upgrade version#

From 3.X to 4.X#

You will need the latest version of the proxy worker. Redeploy a new worker using our self-hosting guide.

After you have the new worker, you will need to get the new sudo-flix deployment files. You CANNOT use the non-PWA version. To upgrade safely without any complications, you need to update with, 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.