Skip to content

Commit e470874

Browse files
committed
Document reinstall
1 parent ad994cf commit e470874

19 files changed

Lines changed: 120 additions & 11 deletions

‎docs/EN/GettingHelp/ReinstallAaps.md‎

Lines changed: 119 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,25 +19,133 @@ If you still have your keystore, you don't need this page: reuse it and [update
1919
(reinstall-aaps-before)=
2020
## Before you start
2121

22-
- Uninstalling **AAPS** deletes all its settings, your objectives and the current pump connection. You get them back by importing your **settings file**, so make sure you have a recent one.
23-
- The settings file does not contain your treatment and glucose history. If you upload to Nightscout, your past data is still available there.
22+
- Uninstalling **AAPS** deletes all its settings, your [objectives](../SettingUpAaps/CompletingTheObjectives.md) and the current pump connection. You get them back by importing your **settings file**, so make sure you have a recent one.
23+
- The settings file does not contain your treatment and glucose history. If you upload to [Nightscout](../SettingUpAaps/SettingUpTheReportingServer.md), you can load it back after the reinstall (step 8).
24+
- You need your [**master password**](#Preferences-master-password): the settings file is encrypted with it.
2425
- **Omnipod and Medtrum users:** read [Tubeless pumps](#ExportImportSettings-tubeless-pumps) first. Your settings file must have been exported during the pod or patch you are wearing now.
2526
- If needed, [set up your CGM/BG source receiver](../Getting-Started/CompatiblesCgms.md) before you start.
2627

2728
(reinstall-aaps-steps)=
2829
## Steps
2930

30-
1. [Export settings](#ExportImportSettings-Automating-Settings-Export) on your phone.
31-
2. Copy or upload the settings file from your phone to an external location (i.e. your computer, cloud storage service...).
32-
3. [Build](../SettingUpAaps/BuildingAaps.md) a new signed apk with your new keystore and transfer it to your phone.
33-
4. Uninstall previous **AAPS** version on your phone.
34-
5. Install new **AAPS** version on your phone.
35-
6. [Import settings](#ExportImportSettings-restoring-from-your-backups-on-a-new-phone-or-fresh-installation-of-aaps) to restore your objectives and configuration.
31+
The pictures show a move from **AAPS** 3.4 (steps 1 to 3) to **AAPS** 4 (steps 6 to 8). Other versions look slightly different.
3632

37-
If you can't find these on your phone, copy them from the external storage to your phone.
33+
(reinstall-aaps-export)=
34+
### 1. Export your settings
3835

39-
7. Check your battery optimization options and disable them again.
40-
8. Keep on looping.
36+
Export your settings with the **AAPS** currently installed on your phone. See [Settings Export](#ExportImportSettings-Settings-Export) for details.
37+
38+
In **AAPS** 3.4: open **Maintenance** and tap **Export options**. Under **User Settings**, tick **Local Storage** and tap **OK**.
39+
40+
*Note: you can also use [Cloud Storage](#preferences-maintenance-cloud) to have a safety backup copy: that's a good idea, but keep Local Storage for recovering settings quickly.*
41+
42+
![Export options with User Settings set to Local Storage](../images/ReinstallAaps/reinstall_export_options_local.png)
43+
44+
The button now reads **Export settings (local)**. Tap it.
45+
46+
![Maintenance with the Export settings (local) button](../images/ReinstallAaps/reinstall_export_settings_local.png)
47+
48+
**AAPS** shows the name of the file it will create. Tap **OK**, type your master password and tap **OK**.
49+
50+
![Export settings confirmation with the file name](../images/ReinstallAaps/reinstall_export_confirm.png)
51+
52+
In **AAPS** 4: open **Maintenance**, select the **Local** chip next to **Export settings** and tap **Export settings**.
53+
54+
(reinstall-aaps-copy)=
55+
### 2. Copy the settings file off your phone
56+
57+
The file is in the **preferences** folder of your [**AAPS** directory](#SetupWizard-StoragePermission), named like `2026-10-13_222735_full.json`. Copy or upload it to an external location (i.e. your computer, cloud storage service...). The file normally stays on your phone after the uninstall, but keep a copy elsewhere in case.
58+
59+
(reinstall-aaps-nightscout-before)=
60+
### 3. Synchronize with Nightscout
61+
62+
This step is not mandatory but recommended if you use [DynISF](#Open-APS-features-DynamicISF): it will allow you to resume directly with the current settings instead of waiting 5 days to build necessary data for the plugin. NSClient V3 needs to be [enabled and configured](../SettingUpAaps/SettingUpTheReportingServer.md).
63+
64+
Make sure Nightscout has all your data before you uninstall.
65+
66+
Open **NSClient**, tap the menu (⋮) and **Full synchronization**, then **OK**.
67+
68+
![NSClient menu with Full synchronization](../images/ReinstallAaps/reinstall_ns_fullsync_menu_before.png)
69+
70+
*Note: the time necessary depends on your Nightscout hosting service.*
71+
72+
![Full synchronization confirmation](../images/ReinstallAaps/reinstall_ns_fullsync_confirm.png)
73+
74+
**AAPS** then offers to clean up its database. **OK** removes data older than 3 months from the phone, which makes the synchronization much faster. **Cancel** synchronizes without cleaning up. The phone database is deleted when you uninstall anyway, so both are fine.
75+
76+
![Database cleanup question](../images/ReinstallAaps/reinstall_ns_fullsync_cleanup.png)
77+
78+
Leave **AAPS** running until the synchronization is finished.
79+
80+
(reinstall-aaps-build)=
81+
### 4. Build the new apk
82+
83+
[Build](../SettingUpAaps/BuildingAaps.md) a new signed apk with your new keystore and transfer it to your phone.
84+
85+
(reinstall-aaps-uninstall)=
86+
### 5. Uninstall AAPS
87+
88+
In your phone's **Settings** > **Apps** > **AAPS**, tap **Uninstall** and confirm with **OK**.
89+
90+
![App info of AAPS with the Uninstall button](../images/ReinstallAaps/reinstall_uninstall_appinfo.png)
91+
92+
(reinstall-aaps-install)=
93+
### 6. Install and start the new AAPS
94+
95+
[Install](../SettingUpAaps/TransferringAndInstallingAaps.md) the new apk and start **AAPS**. The [setup wizard](../SettingUpAaps/SetupWizard.md) asks for the permissions **AAPS** needs: tap **Grant** for each of them. This also turns [battery optimization](#setup-wizard-bluetooth-battery-optimisation) off again.
96+
97+
![Permissions Required list of the setup wizard](../images/ReinstallAaps/reinstall_permissions.png)
98+
99+
For **AAPS Directory**, select the same **AAPS** folder as before (the one with the **preferences** folder in it), tap **Use this folder** and **Allow**.
100+
101+
![Selecting the existing AAPS folder](../images/ReinstallAaps/reinstall_aaps_directory.png)
102+
103+
When **AAPS** finds your exported settings, the setup wizard shows a [Stored settings found](#setup-wizard-import-settings) screen where you can import them. You can also close the wizard and import from **Maintenance** as described below.
104+
105+
(reinstall-aaps-import)=
106+
### 7. Import your settings
107+
108+
If the settings file is no longer on your phone, copy it back to the **preferences** folder of your **AAPS** directory.
109+
110+
Open the menu (☰) > **Maintenance**, select the **Local** chip next to **Import settings** and tap **Import settings**.
111+
112+
![Maintenance with Import settings](../images/ReinstallAaps/reinstall_maintenance_import.png)
113+
114+
The list shows each file with its **AAPS** version and how old it is. Choose the file you exported in step 1.
115+
116+
![List of settings files to import](../images/ReinstallAaps/reinstall_import_file_list.png)
117+
118+
You don't need to set a master password in the new **AAPS** first. Type the master password you used for the export in **Decryption password** and tap **Decrypt**. **File was encrypted with a different password** is expected: the new **AAPS** doesn't know your password yet. The import restores it with your other settings.
119+
120+
![Decryption password for the settings file](../images/ReinstallAaps/reinstall_import_password.png)
121+
122+
Tick **Also replace pump settings**: without it, your pump and its settings are not restored. Omnipod and Medtrum users: only tick it if the file was exported during your current pod or patch (see [Tubeless pumps](#ExportImportSettings-tubeless-pumps)).
123+
124+
![Also replace pump settings ticked](../images/ReinstallAaps/reinstall_import_replace_pump.png)
125+
126+
Tap **Import**, then **OK** to apply the settings and **OK** again on **Settings applied**.
127+
128+
![Apply imported settings confirmation](../images/ReinstallAaps/reinstall_import_apply.png)
129+
130+
(reinstall-aaps-nightscout-after)=
131+
### 8. Get your history back from Nightscout
132+
133+
Open the menu (☰) > [**Configuration**](../SettingUpAaps/ChangeAapsConfiguration.md) > **Communication** and tap **Open plugin** under **NSClientV3**. Check that the status shows **Connected**. If it doesn't, see [Troubleshooting NSClient](TroubleshootingNsClient.md).
134+
135+
![Communication with the NSClientV3 Open plugin button](../images/ReinstallAaps/reinstall_ns_open_plugin.png)
136+
137+
Tap the menu (⋮) > **Full synchronization** and **OK**. The database is new, so you can answer the cleanup question either way.
138+
139+
![NSClientV3 menu with Full synchronization](../images/ReinstallAaps/reinstall_ns_fullsync_menu_after.png)
140+
141+
**AAPS** loads your data from Nightscout. The log shows **Full sync finished** when it is done.
142+
143+
![NSClientV3 log with Full sync finished](../images/ReinstallAaps/reinstall_ns_fullsync_finished.png)
144+
145+
(reinstall-aaps-check)=
146+
### 9. Check and keep looping
147+
148+
Check that your pump is connected and your CGM values arrive, then keep on looping.
41149

42150
(reinstall-aaps-afterwards)=
43151
## Afterwards

‎docs/EN/SettingUpAaps/SetupWizard.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,7 @@ Please **DO NOT LOSE YOUR MASTER PASSWORD**. Make a note of it _e.g._ on Google
177177

178178
When you are done, press "**NEXT**" to go to the next screen.
179179

180+
(setup-wizard-import-settings)=
180181
## Import settings
181182

182183
This screen is only shown when **AAPS** finds settings exported earlier in the **AAPS** directory ("Stored settings found"), for example when you reinstall the app or move to a new phone.
29.1 KB
Loading
52.5 KB
Loading
63.7 KB
Loading
44.2 KB
Loading
36.7 KB
Loading
28.6 KB
Loading
74.4 KB
Loading
46.2 KB
Loading

0 commit comments

Comments
 (0)