Skip to content
Snippets Groups Projects
update.md 3.28 KiB
Newer Older
  • Learn to ignore specific revisions
  • ---
    title: Update
    sidebarDepth: 3
    ---
    
    # How to update Castopod?
    
    After installing Castopod, you may want to update your instance to the latest
    version in order to enjoy the latest features ✨, bug fixes 🐛 and performance
    improvements ⚡.
    
    
    crowdin's avatar
    crowdin committed
    ## Update instructions
    
    crowdin's avatar
    crowdin committed
    0. ⚠️ Before any update, we highly recommend you backup your Castopod files and
       database.
    
    crowdin's avatar
    crowdin committed
       - cf.
         [Should I make a backup before updating?](#should-i-make-a-backup-before-updating)
    
    
    1. Go to the
       [releases page](https://code.castopod.org/adaures/castopod/-/releases) and
       see if your instance is up to date with the latest Castopod version
    
       - cf.
         [Where can I find my Castopod version?](#where-can-i-find-my-castopod-version)
    
    2. Download the latest release package named `Castopod Package`, you may choose
       between the `zip` or `tar.gz` archives
    
       - ⚠️ Make sure you download the Castopod Package and **NOT** the Source Code
    
    crowdin's avatar
    crowdin committed
       - Note that you can also download the latest package from
         [castopod.org](https://castopod.org/)
    
    
    3. On your server:
    
       - Remove all files except `.env` and `public/media`
       - Copy the new files from the downloaded package into your server
    
         ::: info Note
    
         You may need to reset files permissions as during the install process.
         Check [Security Concerns](./security.md).
    
         :::
    
    
    crowdin's avatar
    crowdin committed
    4. Update your database schema from your `Castopod Admin` > `About` page or by
       running:
    
    crowdin's avatar
    crowdin committed
       ```bash
       php spark castopod:database-update
       ```
    
    crowdin's avatar
    crowdin committed
    5. Clear your cache from your `Castopod Admin` > `Settings` > `general` >
       `Housekeeping`
    
    6. ✨ Enjoy your fresh instance, you're all done!
    
    
    crowdin's avatar
    crowdin committed
    ::: info Note
    
    Releases may come with additional update instructions (see
    [releases page](https://code.castopod.org/adaures/castopod/-/releases)).
    
    - cf.
      [I haven't updated my instance in a long time… What should I do?](#i-havent-updated-my-instance-in-a-long-time-what-should-i-do)
    
    :::
    
    ## Fully Automated updates
    
    > Coming soon... 👀
    
    
    ## Frequently asked questions (FAQ)
    
    ### Where can I find my Castopod version?
    
    Go to your Castopod admin panel, the version is displayed on the bottom left
    corner.
    
    Alternatively, you can find the version in the `app > Config > Constants.php`
    file.
    
    
    ### [I haven't updated my instance in a long time… What should I do?](#i-havent-updated-my-instance-in-a-long-time-what-should-i-do)
    
    
    No problem! Just get the latest release as described above. Only, when going
    through the release instructions (4), perform them sequentially, from the oldest
    to the newest.
    
    > You may want to backup your instance depending on how long you haven't updated
    > Castopod.
    
    For example, if you're on `v1.0.0-alpha.42` and would like to upgrade to
    `v1.0.0-beta.1`:
    
    0. (highly recommended) Make a backup of your files and database.
    
    1. Download the latest release, overwrite your files whilst keeping `.env` and
       `public/media`.
    
    2. Go through each release update instructions sequentially (from oldest to
       newest) starting with `v1.0.0-alpha.43`, `v1.0.0-alpha.44`,
       `v1.0.0-alpha.45`, …, `v1.0.0-beta.1`.
    
    3. ✨ Enjoy your fresh instance, you're all done!
    
    ### Should I make a backup before updating?
    
    We advise you do, so you don't lose everything if anything goes wrong!
    
    More generally, we advise you make regular backups of your Castopod files and
    database to prevent you from losing it all…