Skip to content

Commit 95638fa

Browse files
committed
Set the AAPS directory when restoring to a new phone
#2535
1 parent 82c302d commit 95638fa

7 files changed

Lines changed: 34 additions & 20 deletions

docs/EN/Maintenance/ExportImportSettings.md

Lines changed: 32 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,9 @@ When installing AAPS on your phone it becomes a "medical device" you rely on dai
44
emergency backup plan for when your phone gets defective, stolen or lost. Therefore, it is essential to prepare by asking yourself, "What if?
55

66
To restore your AAPS setup to an existing or new phone, it's important to keep following items in a secure location (read: not on your phone).
7-
Best practice is to keep at least two separate backups: on a local hard drive, USB stick and (preferred) on Cloud storage like Google Drive or
8-
Microsoft 365 OneDrive. By storing your backups in the cloud you'll always have everything needed accessible from your phone
9-
to restore your setup anywhere and anytime.
7+
Best practice is to keep at least two separate backups: on a local hard drive, USB stick and (preferred) on Cloud storage like Google Drive or Microsoft 365 OneDrive. By storing your backups in the cloud you'll always have everything needed accessible from your phone to restore your setup anywhere and anytime.
108

11-
Consider acquiring a secondary backup phone and practicing restoring AAPS to ensure the backup phone works as expected. This step will give
12-
you confidence that your emergency plan is effective and that you can seamlessly continue using AAPS if your primary phone becomes unavailable.
9+
Consider acquiring a secondary backup phone and practicing restoring AAPS to ensure the backup phone works as expected. This step will give you confidence that your emergency plan is effective and that you can seamlessly continue using AAPS if your primary phone becomes unavailable.
1310

1411
To be able to restore, having the following items at hand is important:
1512

@@ -41,19 +38,21 @@ In case your main **AAPS** phone is lost or damaged, having a copy of the APK av
4138
**How to back-up:** Maintain a copy on the computer used to build the APK with Android Studio. Additionally, it is recommended to use a cloud platform to store a copy of the installer APK. Make sure you know how to locate both backups when needed. Consider setting up dedicated folders to store these backups.
4239

4340
### AAPS settings file (also referred to as 'Preferences')
41+
42+
```{admonition} Where are preferences stored on my phone?
43+
:class: tip
44+
You will find your settings in the **AAPS Directory** you have selected during [AAPS setup](#SetupWizard-StoragePermission).</br>
45+
You can also change the **AAPS Directory** in Preferences > [Maintenance Settings](#preferences-maintenance-settings).
46+
```
47+
4448
With a copy of the APK installer file (see above) and your **Settings** file, you can quickly get up and running on an existing or new phone.
4549

46-
The **Settings** file is used t customize the AAPS application to fit your specific setup. They encompass details such as your config builder settings,
47-
objective status, third-party communication settings (e.g., Nightscout, Tidepool), automations, and profiles.
50+
The **Settings** file is used to customize the AAPS application to fit your specific setup. They encompass details such as your config builder settings, objective status, third-party communication settings (e.g., Nightscout, Tidepool), automations, and profiles.
4851

49-
Exporting the AAPS settings to file enables you to restore its configuration to a specific point in time. As mentioned, in addition to all
50-
configuration settings, the export file also contains the status of your objectives, which you need to restore when **(re)installing** AAPS. Without
51-
this you will be required to redo all objectives from start to enable closed loop. Settings files also enable you to restore "last known good" settings
52-
for undoing any configuration changes.
52+
Exporting the AAPS settings to file enables you to restore its configuration to a specific point in time. As mentioned, in addition to all configuration settings, the export file also contains the status of your objectives, which you need to restore when **(re)installing** AAPS. Without this you will be required to redo all objectives from start to enable closed loop. Settings files also enable you to restore "last known good" settings for undoing any configuration changes.
5353

5454
**When to back-up AAPS settings:**
55-
* Each time you complete an objective to prevent losing your progress. _Without a copy of your **Settings** you will have to complete all objectives again
56-
in the event you need to re-install AAPS or replace your phone._
55+
* Each time you complete an objective to prevent losing your progress. _Without a copy of your **Settings** you will have to complete all objectives again in the event you need to re-install AAPS or replace your phone._
5756

5857
* Any time you plan to make significant changes to your configuration (change SMB settings, change insulin types, change pump, make changes to automations) you should back up your **Settings** before and after making the changes. This way you have your most recent settings as well as a copy of what they were before the changes in case you need to revert back to them.
5958

@@ -74,9 +73,13 @@ in the event you need to re-install AAPS or replace your phone._
7473

7574
## Settings Export ##
7675

77-
It is recommended to do regular settings exports, especially before and after making configuration changes. You can choose to do exports
78-
**manually or (preferred) through automation**. Make sure to take a note of your AAPS master password and to backup your settings
79-
files by copying them off your phone to for instance a cloud storage location.
76+
```{admonition} Where are preferences stored on my phone?
77+
:class: tip
78+
You will find your settings in the **AAPS Directory** you have selected during [AAPS setup](#SetupWizard-StoragePermission).</br>
79+
You can also change the **AAPS Directory** in Preferences > [Maintenance Settings](#preferences-maintenance-settings).
80+
```
81+
82+
It is recommended to do regular settings exports, especially before and after making configuration changes. You can choose to do exports **manually or (preferred) through automation**. Make sure to take a note of your AAPS master password and to backup your settings files by copying them off your phone to for instance a cloud storage location.
8083

8184
**Note**: _The exported settings will be encrypted with your AAPS master password: without the master password used for exporting
8285
you will be unable to import the settings file!_
@@ -99,6 +102,13 @@ _**Note:** On importing settings to user always needs to enter the AAPS password
99102

100103
(ExportImportSettings-restoring-from-your-backups-on-a-new-phone-or-fresh-installation-of-aaps)=
101104
## Restoring from your backups on a new phone or fresh installation of AAPS
105+
106+
```{admonition} Where are preferences stored on my phone?
107+
:class: tip
108+
You will find your settings in the **AAPS Directory** you have selected during [AAPS setup](#SetupWizard-StoragePermission).</br>
109+
You can also change the **AAPS Directory** in Preferences > [Maintenance Settings](#preferences-maintenance-settings).
110+
```
111+
102112
Use these instructions if you have a back-up of your APK and **Preferences** that you want to load on to a new phone or if you needed to delete and reinstall the APK on your existing phone for any reason.
103113

104114
_If you are updating **AAPS** using an APK built with the same keystore you should not need to follow this process. However, it is still advised to create a back-up before you apply the update._
@@ -122,13 +132,15 @@ Importing a **Preferences** file will deactivate your current pod if those **Pre
122132

123133
5. From the **AAPS** home screen, set the master password in [Preferences > General > Protection](#Preferences-master-password) to the same password as you used with your back-ups.
124134

125-
6. From the **AAPS** home screen, select the three line (hamburger) menu in the top left > Maintenance > Export settings > type in Master password set above > Ok. This will create the preferences folder if it does not already exist on your phone.
135+
6. If you haven't done it yet, [set the **AAPS Directory**](#preferences-maintenance-settings): from the **AAPS** home screen, select the three line (hamburger) menu in the top left > Maintenance > AAPS DIRECTORY.
136+
137+
7. From the **AAPS** home screen, select the three line (hamburger) menu in the top left > Maintenance > Export settings > type in Master password set above > Ok. This will create the preferences folder if it does not already exist on your phone.
126138

127-
7. Download the back-up of your **Preferences** file from your cloud platform.
139+
8. Download the back-up of your **Preferences** file from your cloud platform.
128140

129-
8. Use your file explorer (commonly called “Files” or “My Files”) to move the file from your downloads to `/internal storage/AAPS/preferences`
141+
9. Use your file explorer (commonly called “Files” or “My Files”) to move the file from your downloads to `/internal storage/AAPS/preferences` if your **AAPS Directory** has been set `/internal storage/AAPS`
130142

131-
9. From the **AAPS** home screen, select the three line (hamburger) menu in the top left > Maintenance > Import settings > select the preferences file you want to back-up from > Ok > type in Master password set above > Ok. Make sure you select the correct preferences file, all .json files from the preferences folder will be shown.
143+
10. From the **AAPS** home screen, select the three line (hamburger) menu in the top left > Maintenance > Import settings > select the preferences file you want to back-up from > Ok > type in Master password set above > Ok. Make sure you select the correct preferences file, all .json files from the preferences folder will be shown.
132144

133145
![AAPS import settings 1](../images/Maintenance/AAPS_ImportSettings1.png)
134146
![AAPS import settings 2](../images/Maintenance/AAPS_ImportSettings2.png)

docs/EN/SettingUpAaps/SetupWizard.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,8 @@ Follow these steps on Android 16, other versions will varies slightly from the p
125125

126126
![settings_apps](../images/setup-wizard/app_bluetooth_allow_background_unrestrict.png)
127127

128+
(SetupWizard-StoragePermission)=
129+
128130
### Storage permission
129131

130132
**AAPS** needs to log information to the permanent storage of your smartphone. Permanent storage means that it will be available even after rebooting your smartphone. Other information is just lost, as it is not saved to permanent storage.
-2.5 KB
Loading
-18 KB
Loading
-25.8 KB
Loading
6.9 KB
Loading
-9.58 KB
Loading

0 commit comments

Comments
 (0)