2022-02-19 17:06:11 +01:00
|
|
|
---
|
|
|
|
title: Update
|
|
|
|
sidebarDepth: 3
|
|
|
|
---
|
2021-05-20 16:31:39 +02:00
|
|
|
|
2022-02-19 17:06:11 +01:00
|
|
|
# How to update Castopod?
|
2021-05-20 16:31:39 +02:00
|
|
|
|
2022-02-19 17:06:11 +01:00
|
|
|
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 ⚡.
|
2021-05-20 16:31:39 +02:00
|
|
|
|
2022-10-18 18:53:51 +02:00
|
|
|
## Update instructions
|
2022-02-19 17:06:11 +01:00
|
|
|
|
2022-10-18 18:53:51 +02:00
|
|
|
0. ⚠️ Before any update, we highly recommend you backup your Castopod files and
|
|
|
|
database.
|
2021-05-20 16:31:39 +02:00
|
|
|
|
2022-10-18 18:53:51 +02:00
|
|
|
- cf.
|
|
|
|
[Should I make a backup before updating?](#should-i-make-a-backup-before-updating)
|
2021-05-20 16:31:39 +02:00
|
|
|
|
|
|
|
1. Go to the
|
2022-02-20 14:23:57 +01:00
|
|
|
[releases page](https://code.castopod.org/adaures/castopod/-/releases) and
|
2022-02-19 17:06:11 +01:00
|
|
|
see if your instance is up to date with the latest Castopod version
|
2021-05-20 16:31:39 +02:00
|
|
|
|
|
|
|
- cf.
|
2022-02-19 17:06:11 +01:00
|
|
|
[Where can I find my Castopod version?](#where-can-i-find-my-castopod-version)
|
2021-05-20 16:31:39 +02:00
|
|
|
|
2022-02-19 17:06:11 +01:00
|
|
|
2. Download the latest release package named `Castopod Package`, you may choose
|
|
|
|
between the `zip` or `tar.gz` archives
|
2021-05-20 16:31:39 +02:00
|
|
|
|
2022-02-19 17:06:11 +01:00
|
|
|
- ⚠️ Make sure you download the Castopod Package and **NOT** the Source Code
|
2022-10-18 18:53:51 +02:00
|
|
|
- Note that you can also download the latest package from
|
|
|
|
[castopod.org](https://castopod.org/)
|
2021-05-20 16:31:39 +02:00
|
|
|
|
|
|
|
3. On your server:
|
|
|
|
|
|
|
|
- Remove all files except `.env` and `public/media`
|
|
|
|
- Copy the new files from the downloaded package into your server
|
2022-02-19 17:06:11 +01:00
|
|
|
|
|
|
|
::: info Note
|
|
|
|
|
|
|
|
You may need to reset files permissions as during the install process.
|
|
|
|
Check [Security Concerns](./security.md).
|
|
|
|
|
|
|
|
:::
|
2021-05-20 16:31:39 +02:00
|
|
|
|
2022-10-18 18:53:51 +02:00
|
|
|
4. Update your database schema from your `Castopod Admin` > `About` page or by
|
|
|
|
running:
|
2021-05-20 16:31:39 +02:00
|
|
|
|
2022-10-18 18:53:51 +02:00
|
|
|
```bash
|
|
|
|
php spark castopod:database-update
|
|
|
|
```
|
2021-05-20 16:31:39 +02:00
|
|
|
|
2022-10-18 18:53:51 +02:00
|
|
|
5. Clear your cache from your `Castopod Admin` > `Settings` > `general` >
|
|
|
|
`Housekeeping`
|
2021-07-12 19:47:56 +02:00
|
|
|
6. ✨ Enjoy your fresh instance, you're all done!
|
2021-05-20 16:31:39 +02:00
|
|
|
|
2022-10-18 18:53:51 +02:00
|
|
|
::: 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... 👀
|
|
|
|
|
2021-05-20 16:31:39 +02:00
|
|
|
## Frequently asked questions (FAQ)
|
|
|
|
|
2022-02-19 17:06:11 +01:00
|
|
|
### Where can I find my Castopod version?
|
2021-05-20 16:31:39 +02:00
|
|
|
|
2022-02-19 17:06:11 +01:00
|
|
|
Go to your Castopod admin panel, the version is displayed on the bottom left
|
|
|
|
corner.
|
2021-05-20 16:31:39 +02:00
|
|
|
|
|
|
|
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?
|
|
|
|
|
|
|
|
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
|
2022-02-19 17:06:11 +01:00
|
|
|
> Castopod.
|
2021-05-20 16:31:39 +02:00
|
|
|
|
|
|
|
For example, if you're on `v1.0.0-alpha.42` and would like to upgrade to
|
2022-01-22 15:44:07 +01:00
|
|
|
`v1.0.0-beta.1`:
|
2021-05-20 16:31:39 +02:00
|
|
|
|
2022-02-19 17:06:11 +01:00
|
|
|
0. (highly recommended) Make a backup of your files and database.
|
2021-05-20 16:31:39 +02:00
|
|
|
|
|
|
|
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`,
|
2022-01-22 15:44:07 +01:00
|
|
|
`v1.0.0-alpha.45`, …, `v1.0.0-beta.1`.
|
2021-05-20 16:31:39 +02:00
|
|
|
|
|
|
|
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!
|
|
|
|
|
2022-02-19 17:06:11 +01:00
|
|
|
More generally, we advise you make regular backups of your Castopod files and
|
|
|
|
database to prevent you from losing it all…
|