Upgrade Path

Frigate 0.3.0 → 0.18.0

42 versions, 15 with breaking changes (1 repeats an earlier entry), 0 required stops

Version by version, oldest first

0.5.0 2020-03-04

Breaking

  • You must pass the shm-size parameter to your container via the command line or docker-compose. Check the updated README
  • New required fps parameter for the each camera. See example
  • Debug endpoint changed. See updated README

Full release notes for 0.5.0

0.5.1 – 0.5.2: no action items (2 versions)

0.6.0 2020-09-21

Breaking

  • In previous versions, ffmpeg used -vsync drop as an input parameter. It is incompatible with the new save_clips feature, so you will need to remove it if you added it directly to your config.

Full release notes for 0.6.0

0.6.1: no action items (1 version)

0.7.0 2020-10-18

Breaking

  • Default output_args for cameras have changed. If you specified custom output parameters, you will need to update.
  • Updated config for specifying coral device. See new detectors section in the example config.
  • New json structure at /debug/stats to handle multiple detectors

Full release notes for 0.7.0

0.7.1 – 0.7.3: no action items (3 versions)

0.8.0 2021-01-27

Breaking

  • The web_port is no longer configurable and is fixed at 5000
  • For RTMP support, port 1935 needs to be made available
  • All previous automations built around frigate/<camera>/events/start|end will need to be replaced
  • The clips_dir is now at /media/frigate/clips and the cache_dir now at /tmp/cache. These are no longer configurable.
  • /debug/stats is now /api/stats
  • If you are specifying your thresholds for person detection, 0.85 will now be WAY too high. Update them to 0.7 or remove from your config and use the default. The new model doesn’t score detections as high, but has a much lower false positive rate.
  • The previous mask value is now under the motion config section
  • Masks are now configured like zones and image masks are no longer supported
  • Fallback to CPU if the EdgeTPU is not detected has been disabled. It will now keep trying to detect your EdgeTPU.

Note

This release is a monster. If upgrading from 0.7.x, I recommend starting with a fresh config file. There are several breaking changes to the config. See updated docs linked in the readme.

Full release notes for 0.8.0

0.8.1 – 0.8.4: no action items (4 versions)

0.9.0 2021-10-05

Breaking

BREAKING: Clips have been merged into Recordings

Frigate now records footage from the camera one time. You define retention settings to determine what you want to keep. You can set it to retain all footage for the number of days you want and/or have a different retention setting for recorded footage that contains detected objects. When you view footage for an event, you are viewing the recorded footage for the time where the event occurred. The "Download Clip" button on the event view will dynamically create an mp4 from the recordings for download.

Separating events and recording this way has significant benefits. Overlapping events no longer mean that the same video footage is stored multiple times on disk. Also, the issue with the cache expiring for long running events is eliminated.

If I used clips without 24/7 recording before, does this mean I have to now record 24/7?

No. If you only want to store footage of events, the following config should be used:

record:
  enabled: true
  retain_days: 0
  events:
    retain:
      default: 10

Breaking

BREAKING: width/height/fps moved under detect

Due to regular confusion about which input the height/width/fps applied to, these settings have been moved under the detect section of the config. Here is an example of a simple config:

cameras:
  back:
    ffmpeg:
      inputs:
        - path: rtsp://viewer:{FRIGATE_RTSP_PASSWORD}@10.0.10.10:554/cam/realmonitor?channel=1&subtype=2
          roles:
            - detect
    detect:
      width: 1280
      height: 720
      fps: 5

Full release notes for 0.9.0

0.9.1 2021-10-05

Breaking

Same text as in 0.9.0, above.

Breaking

Same text as in 0.9.0, above.

Full release notes for 0.9.1

0.9.2 – 0.9.4: no action items (3 versions)

0.10.0 2022-02-19

Breaking

Camera Names

Camera names in the config file must be URL safe starting with this version. Only A-Z, a-z, 0-9, -, and _ are permitted. If your cameras need to be renamed, any associated events will be retained based on your global retain settings, not the new camera name settings. If you want to retain recordings from the previous camera name, you need to ensure you have retain days set globally. For example:

record: #  <---------- global setting
  retain:
    days: 7 # <------- will retain 7 days of recordings for old cameras

Full release notes for 0.10.0

0.10.1: no action items (1 version)

0.11.0 2022-09-22

Breaking

  • Several addon users have reported that a full uninstall and reinstall is necessary. In place upgrades are failing with a "Invalid build environment, can't build this add-on!" message in the supervisor logs.
  • If you are using the Home Assistant integration and/or custom lovelace card, be sure to update those to their latest releases as well.
  • Update to ffmpeg5 will break any custom input arguments using the stimeout parameter. This needs to be renamed to timeout in your config.
  • Some amd64 users may need to set the environment variable LIBVA_DRIVER_NAME=i965 to get similar hardware acceleration performance to previous versions.
  • Upgrading will run migrations on the database file that are not backwards compatible. In order to rollback to 0.10.0, you will either need to restore an old database file or delete the database files so they can be recreated.
  • This version includes a significant rework of the docker build. This may have broken ffmpeg hardware acceleration for some hardware that was working previously. Please open an issue if this happens so we can try and track down what's missing.
  • Some deployment approaches are overwriting the PATH environment value to an old value. If you see errors like No such file or directory: 'ffmpeg', then you need to stop overriding your PATH. This happens with both Proxmox LXC and Portainer (#3223)
  • The max_seconds config setting under events has been removed as it no longer has any effect

Full release notes for 0.11.0

0.11.1: no action items (1 version)

0.12.0 2023-04-08

Breaking

  • We are no longer pushing images to Dockerhub. All docker builds will be published to github container registry instead. The new image location for stable is ghcr.io/blakeblackshear/frigate:stable
  • If using the Frigate-HomeAssistant Integration it will need to be updated to 4.0.0 to avoid breaking changes with Frigate 0.12
  • Changes have been made to the database, a backup of the database will need to be made before updating if you want to roll-back.
  • Some deployment approaches are overwriting the PATH environment value to an old value. If you see errors like ./run: line 7: exec: nginx: not found, then you need to stop overriding your PATH. This happens with both Proxmox LXC and Portainer (https://github.com/blakeblackshear/frigate/issues/3223)Otherwise the database will need to be deleted to roll-back successfully.
  • Some deployment approaches are overwriting the command docker value giving errors like [Errno 98] Address already in us which need to be set back to default to work https://github.com/blakeblackshear/frigate/issues/5444
  • The shm storage requirements have changed for 0.12, they will likely need to be recalculated and adjusted in the config, see the docs for how to calculate this new value. NOTE: This does not apply to addon users which are unable to configure this value.
  • More config validation checks have been added, it is possible that Frigate will fail to start due to an error that has been caught, the error will need to be fixed before frigate can start.
  • RTMP is now disabled by default and the role is not automatically added. It is highly recommend to move to the new RTSP streams via the bundled go2rtc.
  • Changes have been made to the way recordings segments are stored, external scripts which access the recordings file structure directly may be broken.

Full release notes for 0.12.0

0.12.1: no action items (1 version)

0.13.0 2024-01-31

Breaking

  • ARM 32-bit support has officially been removed. If you are running on a Raspberry Pi with a 32-bit OS, you will need to switch to 64-bit.
  • You will likely experience some additional CPU usage because motion detection is now more sensitive and improve_contrast is now enabled by default. If you have specific values set in your config, it is recommended to remove them and re-calibrate as necessary.
  • If no detect resolution is defined then frigate will now run detect at the native camera resolution. This means if you did not explicitly set the detect width / height AND your sub stream is not 1280x720, then your masks and zones will be configured incorrectly.
  • Stationary object validation is now required, anyone who manually set interval: 0 will need to delete this field from the config or increase the value
  • Changes have been made to the DB schema, downgrading to 0.12 will require restoring from a backup or deleting the DB and existing recordings / snapshots.

NOTE: Some users have reported migrations taking a while and frigate frontend is not available until the migrations are complete.

  • New location for frigate.db: Due to the support for network shares in HA OS and the popularity of storing recordings on a NAS in general, the database has a new default location of /config/frigate.db. This change is going to be done for existing users too, so frigate will automatically move the db for you.
  • For Frigate Addon Users: The migration is handled automatically and no action is required from the user.
  • For Docker Container Users: The migration is handled for you, but you must make sure that the docker CLI or docker-compose binds the entire /config directory and not just the /config/config.yml file.

For example, if your current volume mapping is - /host/path/config_folder/config.yml:/config/config.yml it should now be - /host/path/config_folder/:/config/

  • The previously deprecated record -> retain_days config has been removed, this should be migrated to record -> retain -> days if you have not already.
  • HomeAssistant Integration 5.0 is required for the new features introduced in this release.
  • TensorRT has been updated and the model generation has been refactored. New models will need to be generated for 0.13 and have a new path, check the detector docs for more info.
  • TensorRT now requires Nvidia Driver Version 530+
  • The cameras in /stats have been moved to their own cameras block. This only affects users that were directly reading from the /stats data via the API or MQTT.
  • Removed direct access to the go2rtc http API to mitigate potential remote code execution via the exec source, you will need to map port 1984 and access directly if using go2rtc http api outside of frigate

Full release notes for 0.13.0

0.13.1 – 0.13.2: no action items (2 versions)

0.14.0 2024-08-08

Breaking

There are several breaking changes in this release, Frigate will attempt to update the configuration automatically. In some cases manual changes may be required. It is always recommended to backup your current config and database before upgrading:

  • Simply copy your current config file to a new location
  • Stop Frigate and make a copy of the frigate.db file

Your existing events will not be visible in Frigate's new UI

  • An entirely new way of reviewing camera footage has been implemented in Frigate 0.14, and existing events could not be migrated
  • Recordings can still be viewed in the new UI using the recordings viewer (From Live view, click/tap on a camera and select the History button at the top left)
  • You may want to export any starred/favorite events before upgrading
  • If you are using the Home Assistant integration, events can still be viewed there
  • Recording (enabled: True for record in your config) is required to see review items and motion data in the UI

Zone/mask coordinates are now stored in the config as relative values

  • Frigate's configuration migrator will read your existing mask/zone coordinates and convert them for relative use internally on startup
  • Using the built-in mask/zone editor will make your config file incompatible with prior versions of Frigate
  • If you have mask/zone coordinate values that exceed the detect resolution, it will be ignored and you will see warnings in the log. Delete the mask or zone from your config and then use the editor in the UI to recreate it.

The UI's live mode is now intelligently selected

  • The live_mode config option is now deprecated and should be removed.

Backwards incompatible database changes

  • There are a number of changes made to Frigate's database, which are not backwards compatible. A backup of the database is automatically made on startup, but a manual backup is highly recommended.

Other breaking changes

  • RTMP was deprecated in 0.13 and has been fully removed in 0.14. You will need to remove any rtmp references in your config file.
  • OpenVINO has been upgraded, and Intel Neural Compute sticks are no longer supported. Support for YOLO-NAS models has been added. Additionally, AUTO mode now maps to GPU internally to avoid some unresolved issues with AUTO. The existing YOLO-X model will not work in this version.

Breaking

Upgrade issues

I'm seeing "add mask expects relative coordinates only" in my logs. This is usually caused by a mask or zone having coordinates larger than the camera's detect resolution. The easiest fix would be to remove the mask/zone, restart Frigate, and use the new mask/zone editor to recreate it.

What happened to all my events? An entirely new way of reviewing camera footage has been implemented in Frigate 0.14, so any "events" from any previous versions of Frigate will not be migrated and will not be visible in the new UI. This includes any favorited/starred events. Recordings can still be viewed in the new UI using the recordings viewer (From Live view, click/tap on a camera and select the History button at the top left).

I'm seeing "Preview Not Found" in the UI a lot. Why? Frigate 0.14 now generates "previews": bandwidth-optimized, low frame rate, low resolution videos for your camera footage. These previews are not generated for any footage from older versions of Frigate. Historical full recordings are still viewable from your cameras, however. From Live view, click/tap on a camera and select the History button at the top left.

Full release notes for 0.14.0

0.14.1: no action items (1 version)

0.15.0 2025-02-08

Breaking

There are several breaking changes in this release, Frigate will attempt to update the configuration automatically. In some cases manual changes may be required. It is always recommended to back up your current config and database before upgrading:

  1. Simply copy your current config file to a new location
  2. Stop Frigate and make a copy of the frigate.db file
  • Rewritten SHM system
  • The SHM system has been rewritten to be more stable. This means that a large % of shared memory (SHM) will be used by default but the total usage will not fluctuate, and Frigate will not fail from SHM overflowing. However, this also means that having the correct SHM size for your cameras, detector, and hardware is more important to having a smooth experience with Frigate. A new calculation is done on startup, so if your shm_size is too low then a warning will be printed in the log stating that it needs to be increased.
  • Recording configuration changed
  • The record config has been refactored to allow for direct control of how long alerts and detections are retained. These values will be automatically populated from your current config, but you may want to adjust the values that are set after updating. See the updated docs here and ensure your updated config retains the footage you want it to.
  • ffmpeg updates
  • ffmpeg has been updated to version 7. Some Intel users may need to change what hwaccel preset they are using (preset-vaapi may need to now be preset-intel-qsv-h264 or preset-intel-qsv-h265) if camera feeds are not functioning correctly after upgrading. This may need to be adjusted on a per-camera basis. If a qsv preset is not working properly, you may still need to use a preset-vaapi or revert to the previous ffmpeg version as described below.
  • The new version provides many improvements, but the old version can still be run if needed by specifying path: "5.0" in your ffmpeg: config entry. For example:
    ffmpeg:
      path: "5.0"
  • ffmpeg presets have been updated. It is always recommended to use ffmpeg presets rather than manual arguments.
  • ffmpeg is no longer part of $PATH. In most cases this is handled automatically.
  • go2rtc exec streams will need to add the full path for ffmpeg which in most cases will be /usr/lib/ffmpeg/7.0/bin/ffmpeg.
  • If the go2rtc config has bin: ffmpeg defined, it needs to be removed.
  • The nested model config under a detector has been simplified to just model_path as a string value. This change will be handled automatically through config migration.
  • Submitting to Frigate+
  • The Frigate+ view in the UI has been replaced by the new Explore view. See the notes below.

Note

  • TensorRT models are no longer generated by default, the ENV var must be set

Full release notes for 0.15.0

0.15.1 – 0.15.2: no action items (2 versions)

0.16.0 2025-08-16

Breaking

There are several breaking changes in this release, Frigate will attempt to update the configuration automatically. In some cases manual changes may be required. It is always recommended to back up your current config and database before upgrading:

  1. Simply copy your current config file to a new location
  2. Stop Frigate and make a copy of the frigate.db file
  • The TensorRT detector has been removed for Nvidia GPUs, the ONNX detector should be used instead. Nvidia recently pushed newer packages and dropped compatibility for older versions of TensorRT. Supporting native TensorRT detector directly has shown to be a large burden, making supporting newer hardware more difficult and increasing the difficulty in updating ONNX runtime. The decision has been made to remove the TensorRT detector which will allow us to focus on supporting more models and bringing more features to the Nvidia platform through ONNX runtime. Users who were running the TensorRT detector will need to update their configuration to use the ONNX detector, and download a new model. YOLO-NAS or YOLOv9 are recommended as they provide superior performance and accuracy compared to the models supported by TensorRT. Documentation
  • The go2rtc audio handling has been updated to accept any audio codec instead of only AAC. This makes it easier to get audio from cameras that use PCMA/U audio. However, if the recording ffmpeg preset preset-record-generic-audio-copy is currently used it likely will need to be changed to preset-record-generic-audio-aac to continue to support audio in recordings.
    ffmpeg:
      ...
      output_args: 
        record: preset-record-generic-audio-aac
  • Object detection is now disabled by default. A config migrator will update your config globally with enabled: true for detect:. If you use Frigate with a read-only config, you may need to edit your own config to enable object detection manually.
    detect:
      enabled: true
  • Frigate will no longer fall back to look for a ffmpeg binary in PATH. If you are extending the Frigate image or somehow injecting a custom ffmpeg binary in a place like /usr/local/bin, please read the custom ffmpeg build guide.
  • Home Assistant Add-on users will need to be aware of several important breaking changes. See the Important Notes for Home Assistant Add-on Users section below.
  • The base image for Frigate has been updated to Debian Bookworm. The Jetpack 4 (jp4) and Jetpack 5 (jp5) images have been removed due to not being compatible with the new base image. A new Jetson Jetpack 6 (jp6) build has been contributed by a community member.
  • The camera group icon pack has been updated. Some of your camera group icons may need to be re-selected.
  • The Hailo driver and firmware has been updated to 4.21.0. The standard Docker image now provides Hailo support. If you are using Home Assistant Operating System, version 16.0 is required. Other users will need to update the Hailo driver and firmware on their system using the user installation script.
  • The ROCm migraphx detector has been removed: Instead of separately supporting ROCm via MigraphX and via ONNX, the ROCm (rocm) detector has been removed, and the onnx detector should be used instead. This change should only require changing the type: rocm to type: onnx in detectors
  • An additional parameter has been added to movement_weights for autotracking users. A config migrator will add the new value so that Frigate starts, but if this fails or you are using relative zooming with autotracking, you should remove movement_weights from your config and recalibrate.
  • Proxy header mapping for user roles is now required or setting the default_role to admin is required to achieve the same functionality as previous versions. This version implements a Viewer role, which is now the default for authenticated users without a role header map defined in the config. If you are using a proxy, you must include admin in your mapped role header in order for admin users to retain their elevated privileges. See the documentation.
  • The strftime_fmt config option is now deprecated and will be removed in a future version. The UI will now define time formats based on your language and locale.
  • Some API routes are now protected and require credentials or changes. With the introduction of the Viewer role and the ability to mark review items as reviewed separately per-user, changes may be needed to any services making calls to Frigate's API.
  • Some users may need to adjust the tls_insecure onvif config if ONVIF PTZ controls were previously working in past versions but fail to work in 0.16. The ONVIF package was upgraded for 0.16, and several users have reported that setting tls_insecure: false fixed their issues.

Breaking

Important Notes for Home Assistant Add-on Users

For Home Assistant add-on users only

The Frigate config directory for add-on users was changed from the Home Assistant config directory to the add-on config directory. With this change, the Frigate config file and database are now part of the add-on backup taken by Home Assistant, no longer needing to backup them manually. Note that only backups after 0.16 will benefit of this change. If you took a backup of Frigate 0.15 when updating to 0.16, the Frigate config file and database will not be part of it. In that case, you should still backup them manually before updating to Frigate 0.16.

Automatic migration

Upon the first Frigate 0.16 initialization, all Frigate-related files will be moved from the Home Assistant config directory to the Frigate add-on config directory. This will mean these files will no longer be accessible through your Home Assistant /config directory. They will now be found in the /addon_configs directory, which can also be accessed through the Terminal or VS Code add-ons.

In the new directory, the Frigate config file will be named config.yml rather than frigate.yml. This aligns with people running Frigate through other means. If you want to move back to Frigate 0.15 and did not backup the config file, you can copy the config.yml from the /addons_config back to /config/frigate.yml before restoring the add-on. Consider copying back other files as well, like custom model, custom ffmpeg, and custom go2rtc. Note that the database from 0.16 is not compatible with Frigate 0.15 anyway and thus should not be copied back. To restore the database, you must restore it from a manual backup.

Moving the config directory between add-on variants

The /addon_configs directory contains the config directories of all add-ons. You can move files from one addon config directory to another, like from Frigate Beta to the stable one, or vice-versa. Make sure you do that before uninstalling the add-on, unless you do not select the Also permanently delete this addon's data when uninstalling it.

Breaking change

If your Frigate config file refers to any arbitrary files in the Home Assistant config dir, like echo:/config/ scripts, their references must be manually updated to from /config/ to /homeassistant/.

Warning

  • The base image for Frigate has been updated to Debian 12 ("Bookworm") and Python 3.11, bringing many backend performance improvements. WARNING: The popular tteck Proxmox LXC script won't automatically support Frigate 0.16. Changes will need to be made to the script. Proxmox remains an officially unsupported installation method.

Full release notes for 0.16.0

0.16.1 – 0.16.4: no action items (4 versions)

0.17.0 2026-02-27

Breaking

There are several breaking changes in this release, Frigate will attempt to update the configuration automatically. In some cases manual changes may be required. It is always recommended to back up your current config and database before upgrading:

  1. Simply copy your current config file to a new location
  2. Stop Frigate and make a copy of the frigate.db file
  • GenAI now supports reviews and object descriptions. As a result, the global genai config now only configures the provider. Other fields have moved under objects -> genai. See the new GenAI documentation.
  • Recordings retention is now fully tiered. This means that record -> continuous and record -> motion are separate config fields. See the examples in the documentation.
  • Some of the LPR models have been updated, and most users should manually switch to the small model, which performs well on both CPU and GPU. The large model is the same as 0.16's and is not as accurate as the upgraded small model in 0.17. Use large only if you live in a region with multi-line plates and you are having issues detecting text on them with the small model.
  • strftime_fmt was deprecated in 0.16, and should now be fully removed from the config in 0.17. Date/time formatting is based on the language selected in the UI.
  • The auto detection logic for camera resolution has changed. Some cameras fail to correctly advertise their resolution, and in previous versions, a default value was assumed that was not always correct. You may need to explicitly define detect resolution width and height for cameras in your config if Frigate hangs on startup.
  • The exec, expr, and echo sources for go2rtc are now removed by default to reduce the security risk if an attacker has access to the configuration. This can be disabled using an environment variable GO2RTC_ALLOW_ARBITRARY_EXEC A separate configuration for this for HA addon users will come in a later beta. See the documentation.
  • Nvidia GTX 900 series GPUs are no longer supported due to updates to ONNX Runtime

Full release notes for 0.17.0

0.17.1 – 0.17.2: no action items (2 versions)

0.18.0 2026-09-12

Breaking

There are several breaking changes in this release, Frigate will attempt to update the configuration automatically. In some cases manual changes may be required. It is always recommended to back up your current config and database before upgrading:

  1. Simply copy your current config file to a new location
  2. Stop Frigate and make a copy of the frigate.db file
  • GenAI now supports multiple providers. As a result, the global genai config is now a mapping of keys to GenAI provider setups, and a new roles field defines what tasks each provider will be used for (object descriptions, review summaries, embeddings, chat, etc.). Existing configs will be automatically migrated. Documentation
  • Frigate no longer saves annotated JPEG snapshots (.jpg) to disk. Only a clean, unannotated WebP snapshot (<camera>-<id>-clean.webp) is now stored in /media/frigate/clips/. The clean_copy configuration option has been removed — clean snapshots are always saved when snapshots are enabled. The snapshots.quality default has changed from 70 to 60, reflecting the switch from JPEG to WebP encoding. Users who previously relied on the annotated .jpg files on disk should instead use the /api/events/<id>/snapshot.jpg endpoint, which now honors timestamp, bounding_box, crop, height, and quality query parameters for both in-progress and completed tracked objects. When query parameters are omitted, the camera's snapshots config values are used as defaults. Existing configs containing clean_copy will be automatically migrated. Documentation
  • The config format for zones and masks has changed to add enabled and friendly_name fields. A config migrator will make the necessary changes, but if migration fails you may need to edit your masks and zones manually.
  • Intel GPU stats reporting has changed to no longer require intel_gpu_top and now reads directly from the kernel's per-client DRM usage counters. This removes the need for CAP_PERFMON, privileged mode, or perf_event_paranoid tuning, and adds support for newer Intel GPUs (including Battlemage). Reported usage values may differ from previous versions because the measurement method has changed; the underlying GPU workload is unchanged for the same configuration.
  • Note that this change will require a Linux kernel version of 6.5 or newer on your host. Kernels older than 6.5 do not expose per-engine counters for GPUs using GuC submission.
  • FFmpeg has been updated to version 8 (excluding the -rk image), and introduces a known issue with go2rtc streams that transcode video using hardware acceleration. A small change to the go2rtc config is required. Documentation
  • FFmpeg 5 is deprecated and will be removed from Frigate in 0.19.
  • Users running the JinaV2 semantic search model on a GPU will need to run an embeddings reindex due to changes to the CUDA graphs optimization level.
  • The /api/export DELETE HTTP API endpoint has been removed and refactored to support bulk deletion of exports. A POST to /api/exports should be used instead. Documentation
  • The sync_recordings config option has been removed and replaced by the new Media Sync pane in Settings.
  • The timelapse_args export config option has been removed and replaced by custom exporting ffmpeg arguments. Documentation
  • The ui.date_format and ui.time_format config options have been removed as these fields have been unused since date/time format and handling has been determined by i18n.
  • The DeGirum detector has been removed as the company has ceased operations effective 1 Aug 2026.
  • The DeepStack detector is deprecated and will be removed from Frigate in 0.19.

Full release notes for 0.18.0

Release notes from github.com/blakeblackshear/frigate/releases, checked 17 hours ago. Only text the vendor marks as breaking, or puts in a warning/caution/important note, is shown; read the full notes for anything else.