Skip to content

Commit

Permalink
Update CHANGELOG and separate out upgrade instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
esurface committed Apr 2, 2024
1 parent 1d1ee11 commit 31360ee
Show file tree
Hide file tree
Showing 2 changed files with 76 additions and 1 deletion.
14 changes: 13 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,25 @@
__New Features__
- A new Prompt Box widget available in form authoring allows a form designer to add audio and visual feedback connected to Radio Block widgets. This feature provides a toolset for creating self-guided assessments. See the example in [tangy-forms](https://github.com/Tangerine-Community/tangy-form/blob/master/CHANGELOG.md#v4430)

- Bump version of `tangy-form` to v4.31.1 and `tangy-form-editor` to v7.18.0
- Client Login Screen Custom HTML: A new app-config.json setting, `customLoginMarkup`, allows for custom HTML to be added to the login screen. This feature is useful for adding custom branding or additional information to the login screen. As an example:
```json
"customLoginMarkup": "<div style='text-align: center;'><img src='assets/media/logo.png' alt='logo' style='max-width: 100%;'></div>"
```

__Tangerine Teach__

- Add toggle in Attendence Check for 'late'. A teacher can click through the status of 'present', 'late', or 'absent' for each student.
- Use `studentRegistrationFields` to control showing name and surname of student in the student dashboard

__Libs and Dependencies__
- Bump version of `tangy-form` to v4.31.1 and `tangy-form-editor` to v7.18.0 for the new Prompt Box widget

__Server upgrade instructions__

See the [Server Upgrade Insturctions](https://docs.tangerinecentral.org/system-administrator/upgrade-instructions).

*Special Instructions for this release:* NONE


## v3.30.2

Expand Down
63 changes: 63 additions & 0 deletions docs/system-administrator/upgrade-instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
## Server upgrade instructions

Reminder: Consider using the [Tangerine Upgrade Checklist](https://docs.tangerinecentral.org/system-administrator/upgrade-checklist.html) for making sure you test the upgrade safely.

__Preparation__

Tangerine v3 images are relatively large, around 12GB. The server should have at least 20GB of free space plus the size of the data folder. Check the disk space before upgrading the the new version using the following steps:

```bash
cd tangerine
# Check the size of the data folder.
du -sh data
# Check disk for free space.
df -h
```

If there is **less than** 20 GB plus the size of the data folder, create more space before proceeding. Good candidates to remove are: older versions of the Tangerine image and data backups.
```bash
# List all docker images.
docker image ls
# Remove the image of the version that is not being used.
docker rmi tangerine/tangerine:<unused_version>
# List all data backups.
ls -l data-backup-*
# Remove the data backups that are old and unneeded.
rm -rf ../data-backup-<date>
```

__Upgrade__

After ensuring there is enough disk space, follow the steps below to upgrade the server.

1. Backup the data folder
```bash
# Create a backup of the data folder.
cp -r data ../data-backup-$(date "+%F-%T")
```

2. Confirm there is no active synching from client devices

Check logs for the past hour on the server to ensure it's not being actively used. Look for log messages like "Created sync session" for Devices that are syncing and "login success" for users logging in on the server.

```bash
docker logs --since=60m tangerine
```

3. Install the new version of Tangerine
```bash
# Fetch the updates.
git fetch origin
# Checkout a new branch with the new version tag.
git checkout -b <new_version> <new_version>
# Run the start script with the new version.
./start.sh <new_version>
```

__Clean Up__

After the upgrade, remove the previous version of the Tangerine image to free up disk space.

```bash
docker rmi tangerine/tangerine:<previous_version>
```

0 comments on commit 31360ee

Please sign in to comment.