Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/cli/built-in-commands/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,10 @@ Update -- Updates ExpressionEngine
## Examples:

`php eecli.php update --verbose`

## Related: `update:db`

Use [`update:db`](cli/built-in-commands/update-db.md) when you need to run only database update steps.

- `update` updates files and database.
- `update:db` updates only the database steps.
1 change: 1 addition & 0 deletions docs/cli/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ By default the CLI is located `system/ee/eecli.php` .
- [sync:reindex - Sync content used in search indexes](cli/built-in-commands/sync-reindex.md)
- [sync:upload-directory - Sync files in an upload directory](cli/built-in-commands/sync-upload-directory.md)
- [Update ExpressionEngine](cli/built-in-commands/update.md)
- [update:db - Run database updates only](cli/built-in-commands/update-db.md)
- [Creating a Command](cli/creating-a-command.md)
- [Defining Input](cli/defining-input.md)
- [Displaying Output](cli/displaying-output.md)
1 change: 1 addition & 0 deletions docs/cli/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ $ php system/ee/eecli.php list
| hello | The most basic of commands |
| list | Lists all available commands |
| update | Updates ExpressionEngine |
| update:db | Runs ExpressionEngine database updates |
| cache:clear | Clears all ExpressionEngine caches |
...
```
Expand Down
35 changes: 33 additions & 2 deletions docs/installation/updating.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,13 @@ NOTE: **Website Online Status:** In some versions of ExpressionEngine the curren

You can also update ExpressionEngine via the command line on your server. This allows you to keep your installation's files only writable by your user and not also by your web service.

To update via the [eecli](cli/intro.md) tool, run:
### Full update (files + database)

php eecli.php update
Use [`update`](cli/built-in-commands/update.md) when you need to update both files and database changes.

Example:

php eecli.php update --verbose

#### Options

Expand All @@ -58,6 +62,33 @@ To update via the [eecli](cli/intro.md) tool, run:
- **force-addon-upgrades**: Automatically runs all addon updaters at end of update (advanced)
- **y**: Skip all confirmations. (advanced)

### Database-only update

Use [`update:db`](cli/built-in-commands/update-db.md) when files are already in place and you only need to run database update steps.

Examples:

php eecli.php update:db

php eecli.php update:db --to-version=7.5.3 -y

#### Options

- **rollback**: Rollback last database update
- **verbose,v**: Verbose output
- **y**: Skip all confirmations. (advanced)
- **skip-cleanup**: Skip cleanup steps after update
- **to-version**: Target database version to upgrade to
- **from-version**: Starting database version to upgrade from

#### Notes and caveats

- `--to-version` cannot be greater than the installed app version.
- If the current database version is already at or above the target version, no update steps are run.
- If `--from-version` does not match the detected database version, a warning is shown.
- Rollback requires `system/user/cache/ee_update/database.sql` to exist.
- If you are running against a local installer payload, `EE_INSTALL_MODE` must be set to `TRUE` in `.env.php`.

## Updating Manually

TIP: **Feature Update:**
Expand Down
2 changes: 2 additions & 0 deletions docs/toc_sections/_advanced_usage_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -698,6 +698,8 @@
href: cli/built-in-commands/sync-upload-directory.md
- name: Update ExpressionEngine
href: cli/built-in-commands/update.md
- name: Update Database
href: cli/built-in-commands/update-db.md
- name: Version
href: cli/built-in-commands/version.md
- name: Widget Generator
Expand Down