Skip to content

Commit

Permalink
updates to 2.8.0 upgrade guide
Browse files Browse the repository at this point in the history
  • Loading branch information
dandelany committed Apr 18, 2024
1 parent 70c12c6 commit e214338
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
6 changes: 4 additions & 2 deletions docs/upgrade-guides/2-7-1-to-2-8-0.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,22 @@ Aerie v2.8.0 contains significant changes to our PostgreSQL database structure,
Several changes have been made to the variables used in our `docker-compose.yml` config file. If you are using the supplied config as-is, you don't need to do anything - but if you are using a **modified version of this file** for your own deployment, you'll need to make some updates. You can either:

* Take a fresh copy of our `docker-compose.yml` file and recreate any modifications you made
* Or see the full detailed list of changes to the config variables at the bottom of this document, and manually apply these changes to your own version of the file.
* Or see the [full detailed list of changes](#full-list-of-docker-composeyml-variable-changes) to the config variables in the appendix of this document, and manually apply these changes to your own version of the file.

### Changes to .env file
Several new environment variables are now required. Compare the new version of the `.env` file in the deployment directory to your existing `.env` file and copy over any new variables which are missing in your `.env`.
- existing values, especially AERIE_USERNAME, AERIE_PASSWORD, POSTGRES_USER and POSTGRES_PASSWORD, **must** remain unchanged from your previous version if you plan to migrate your data
- You must fill in (arbitrary) values for the password variables, which are left blank in the released `.env` file

If you plan to migrate your data, follow the [migration instructions below](#for-anyone-migrating-data-to-v280) before running Aerie v2.8.0 for the first time.

## For Aerie Developers
(ie. anyone running Aerie from a cloned version of the `aerie` repository)

* Run `./gradlew clean` **before** checking out `develop` or `v2.8.0` in order to clean up old SQL files.
- Or if you have already checked it out, run `rm -rf deployment/postgres-init-db/sql && git restore deployment/postgres-init-db/sql`
* Several new environment variables are now required. Compare the new version of `env.template` in the repository root to your existing `.env` file and copy over any new variables which are missing in your `.env`. Keep any of your existing values, and fill in (arbitrary) values for the password variables which are blank in the template.
* If you plan to migrate your data, follow the migration instructions below before running Aerie v2.8.0 for the first time
* If you plan to migrate your data, follow the [migration instructions below](#for-anyone-migrating-data-to-v280) before running Aerie v2.8.0 for the first time
* When running v2.8.0 for the first time, make sure to rebuild the backend, and build/pull all containers, ie.:
- `docker compose down --remove-orphans && ./gradlew assemble && docker compose up --pull always -d --build`

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "aerie-docs",
"version": "1.0.1",
"version": "2.8.0",
"private": true,
"engines": {
"node": ">=16.14"
Expand Down

0 comments on commit e214338

Please sign in to comment.