diff --git a/docs/upgrade-guides/2-7-1-to-2-8-0.md b/docs/upgrade-guides/2-7-1-to-2-8-0.md index f4c83d9..cfa20a9 100644 --- a/docs/upgrade-guides/2-7-1-to-2-8-0.md +++ b/docs/upgrade-guides/2-7-1-to-2-8-0.md @@ -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` diff --git a/package.json b/package.json index be3ae4a..965f346 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "aerie-docs", - "version": "1.0.1", + "version": "2.8.0", "private": true, "engines": { "node": ">=16.14"