• Android
  • iOS
  • macOS
  • Windows

Restoring Data from Backup

The easiest way to restore your data to an instance of Codebook (say a fresh install on a new device) is to sync the data over from another copy of Codebook where you had previously updated or synced your data. Alternatively, one can restore data by performing a sync with Dropbox or Google Drive, assuming you have previously used Codebook's Sync feature with either service and have one of the following: a printed copy of your Backup QR Code, a copy of your Word List or a Sync Key backup file.

If restoring your data with Codebook's Sync feature is not an option for you and you are using an iOS device, Apple has instructions available for restoring your data from iCloud and iTunes backups.

There are two ways to restore your data when you have Codebook on another device. If you have a desktop version and a mobile version, you can restore using Desktop WiFi. Otherwise, you need to use Dropbox or Google Drive to restore your data.

  1. Desktop WiFi Sync: Used for Desktop and Mobile Device

    To restore Codebook data on iPhone, iPad and Android via Desktop WiFi:

    1. Launch Codebook on your desktop and sign in
    2. Ensure that your Sync Preference is set to Desktop WiFi (For Windows: File menu -> Preferences -> Sync, for macOS: Codebook menu -> Settings -> Sync)
    3. Leave Codebook on your desktop running and signed in
    4. Install Codebook on your mobile device and set your Sync Key to your existing desktop Sync Key. For detailed instructions see Syncing with a New Device
    5. Select the Sync tab (For iPhone or iPad: More -> Sync, For Android: Home -> Sync)
    6. Ensure Mode is set to Desktop WiFi
    7. Tap on Computer to choose your computer on the network
    8. Tap Start Sync

    To restore Codebook data to a desktop from your iPhone, iPad or Android device via Desktop WiFi:

    1. Install Codebook on your desktop and set your Sync Key to your existing mobile device Sync Key. For detailed instructions see Syncing with a New Device
    2. Set desktop Sync Preference to Desktop WiFi (For Windows: File menu -> Preferences -> Sync, for macOS: Codebook menu -> Settings -> Sync)
    3. Launch Codebook on your mobile device
    4. Select the Sync tab (For iPhone or iPad: More -> Sync, For Android: Home -> Sync)
    5. Ensure Mode is set to Desktop WiFi
    6. Tap on Computer to choose your computer on the network
    7. Tap Start Sync

  2. Sync via Dropbox or Google Drive

    This is the method to restore your data from another device by syncing via the cloud (Dropbox or Google Drive). Let's call the device containing your data Device A and the device that needs the data Device B.

    1. Sync Device A to Dropbox or Google Drive. For detailed instructions see:

      Sync Setup - Dropbox

      Sync Setup - Google Drive

    2. Setup your Sync Key on the Device B to match Device A. You do this by displaying the Sync Key on Device A and scanning it on Device B. For detailed instructions see - Display Sync Key for Scanning
    3. Set Sync Preference on Device B to Dropbox or Google Drive
    4. Perform Sync on Device B

You can use this method to restore your data if you have previously synced to Dropbox or Google Drive AND have either a printed copy of your Codebook Backup Code, a written copy of your Backup Word List or a Sync Key file. You will need to setup your Sync Key using one of these backups, set your Sync Preference to the same Dropbox or Google Drive account and run a Sync.

On android

  • Restore Using a Printed Codebook Backup Code

    1. Start the Sync Key setup process. Sync > Setup Sync Key
    2. The Setup Your Sync Key screen will be displayed. Tap Import Sync Key
    3. The Import Sync Key screen will be displayed. Tap Scan Sync Key
    4. You may be prompted to allow Codebook to Access the camera. If so, select Allow
    5. Point the camera at your Printed Backup Sync Key to capture the code. For help Scanning your QR Code - Trouble Scanning QR Code
    6. Enter the master password associated with the Sync Key. This should be written on the printed Codebook Backup Code
    7. Tap Done
    8. The Sync Key Captured screen will be displayed, tap Next
    9. The Sync Key Setup Complete screen will be displayed, tap Process
    10. To set the sync service, tap Service on the Sync screen
    11. Select the sync service that contains your data - Dropbox or Google Drive
    12. To set the Dropbox or Google Drive account, tap Account to authorize Codebook to access the correct account
    13. Follow the prompts to indicate the account you want to use
    14. Start Sync: Tap Start to run sync

      Make sure to use the account that contains your Codebook data. This will restore the data from the sync service to this device.

  • Restore Using a Word List

    1. Start the Sync Key setup process. Sync > Setup Sync Key
    2. The Setup Your Sync Key screen will be displayed. Tap Import Sync Key
    3. The Import Sync Key screen will be displayed. Tap Enter Word List
    4. Enter the 20 words that comprise your word list in order. Tap Looks Good!. The Sync Key Captured window will be displayed
    5. Select Next
    6. The Sync Key Setup Complete screen will be displayed, tap Done
    7. To set the sync service, tap Service on the Sync screen
    8. Select the sync service that contains your data - Dropbox or Google Drive
    9. To set the Dropbox or Google Drive account, tap Account to authorize Codebook to access the correct account
    10. Follow the prompts to indicate the account you want to use
    11. Start Sync: Tap Start to run sync

      Make sure to use the account that contains your Codebook data. This will restore the data from the sync service to this device.

  • Restore Using a Sync Key File

    1. Start the Sync Key setup process. Sync > Setup Sync Key
    2. The Setup Your Sync Key screen will be displayed. Tap Import Sync Key
    3. The Import Sync Key screen will be displayed. Tap Choose File
    4. Select your Sync Key Backup file. It may be named Codebook.synckey.
    5. Enter the Master Password that was used when the backup sync key file was created. Tap Go
    6. Tap Decrypt Sync Key
    7. The Sync Key Setup Complete screen will be displayed, tap Done
    8. To set the sync service, tap Service on the Sync screen
    9. Select the sync service that contains your data - Dropbox or Google Drive
    10. To set the Dropbox or Google Drive account, tap Account to authorize Codebook to access the correct account
    11. Follow the prompts to indicate the account you want to use
    12. Start Sync: Tap Start to run sync

      Make sure to use the account that contains your Codebook data. This will restore the data from the sync service to this device.

On ios

  • Restore Using a Printed Codebook Backup Code

    1. Start the Sync Key setup process. Sync > Setup Sync Key
    2. The Setup Your Sync Key screen will be displayed. Tap Import Sync Key
    3. The Import Sync Key screen will be displayed. Tap Scan Sync Key
    4. You may be prompted to allow Codebook to Access the camera. If so, select Allow
    5. Point the camera at your Printed Backup Sync Key to capture the code. For help Scanning your QR Code - Trouble Scanning QR Code
    6. Enter the master password associated with the Sync Key. This should be written on the printed Codebook Backup Code
    7. Tap Done
    8. The Sync Key Captured screen will be displayed, tap Next
    9. The Sync Key Setup Complete screen will be displayed, tap Done
    10. To set the sync service, tap Service on the Sync screen
    11. Select the sync service that contains your data - Dropbox or Google Drive
    12. To set the Dropbox or Google Drive account, tap Account to authorize Codebook to access the correct account
    13. Follow the prompts to indicate the account you want to use
    14. Start Sync: Tap Start to run sync

      Make sure to use the account that contains your Codebook data. This will restore the data from the sync service to this device.

  • Restore Using a Word List

    1. Start the Sync Key setup process. Sync > Setup Sync Key
    2. The Setup Your Sync Key screen will be displayed. Tap Import Sync Key
    3. The Import Sync Key screen will be displayed. Tap Enter Word List
    4. Enter the 20 words that comprise your word list in order. Tap Looks Good!. The Sync Key Captured window will be displayed
    5. Select Next
    6. The Sync Key Setup Complete screen will be displayed, tap Done
    7. To set the sync service, tap Service on the Sync screen
    8. Select the sync service that contains your data - Dropbox or Google Drive
    9. To set the Dropbox or Google Drive account, tap Account to authorize Codebook to access the correct account
    10. Follow the prompts to indicate the account you want to use
    11. Start Sync: Tap Start to run sync

      Make sure to use the account that contains your Codebook data. This will restore the data from the sync service to this device.

  • Restore Using a Sync Key File

    1. Start the Sync Key setup process. Sync > Setup Sync Key
    2. The Setup Your Sync Key screen will be displayed. Tap Import Sync Key
    3. The Import Sync Key screen will be displayed. Tap Choose File
    4. Select your Sync Key Backup file. It may be named Codebook.synckey.
    5. Enter the Master Password that was used when the backup sync key file was created.
    6. Tap Done
    7. The Sync Key Setup Complete screen will be displayed, tap Done
    8. To set the sync service, tap Service on the Sync screen
    9. Select the sync service that contains your data - Dropbox or Google Drive
    10. To set the Dropbox or Google Drive account, tap Account to authorize Codebook to access the correct account
    11. Follow the prompts to indicate the account you want to use
    12. Start Sync: Tap Start to run sync

      Make sure to use the account that contains your Codebook data. This will restore the data from the sync service to this device.

On macos

  • Restore Using a Printed Codebook Backup Code

    1. Start the Sync Key setup process. Sync menu > Setup Sync Key...
    2. The Setup Your Sync Key screen will be displayed. Select Import Sync Key
    3. The Import Sync Key screen will be displayed. Select Scan Sync Key
    4. You may be prompted to allow Codebook to Access the camera. If so, select Allow
    5. Point the camera at your Printed Backup Sync Key to capture the code. For help Scanning your QR Code - Trouble Scanning QR Code
    6. The Decrypt Sync Key screen will be displyed. Enter the master password associated with the Sync Key. This should be written on the printed Codebook Backup Code
    7. Click Submit
    8. The Sync Key Captured screen will be displayed, click Done
    9. To set the sync service, open the Codebook Settings window. Codebook -> Settings...
    10. Select the Sync tab on the Settings window.
    11. Click to open the Sync Service drop-down list and select the sync service that contains your data - Dropbox or Google Drive
    12. Start Sync: Sync menu > Start Sync

      You will be prompted to enter the Dropbox or Google Drive account. Make sure to use the account that contains your Codebook data. This will restore the data from the sync service to this device.

  • Restore Using a Word List

    1. Start the Sync Key setup process. Sync menu > Setup Sync Key...
    2. The Setup Your Sync Key screen will be displayed. Select Import Sync Key
    3. The Import Sync Key screen will be displayed. Select Enter Word List
    4. Enter the 20 words that comprise your word list in order. Select Done.The Sync Key Captured window will be displayed
    5. Select Done
    6. To set the sync service, open the Codebook Settings window. Codebook -> Settings...
    7. Select the Sync tab on the Settings window.
    8. Click to open the Sync Service drop-down list and select the sync service that contains your data - Dropbox or Google Drive
    9. Start Sync: Sync menu > Start Sync

      You will be prompted to enter the Dropbox or Google Drive account. Make sure to use the account that contains your Codebook data. This will restore the data from the sync service to this device.

  • Restore Using a Sync Key File

    1. Start the Sync Key setup process. Sync menu > Setup Sync Key...
    2. The Setup Your Sync Key screen will be displayed. Select Import Sync Key
    3. The Import Sync Key screen will be displayed. Select Choose File
    4. Select your Sync Key Backup file. It may be named Codebook.synckey.
    5. Select Import Sync Key
    6. The Decrypt Sync Key screen will be displayed. Enter the Master Password that was used when the backup sync key file was created.
    7. Select Decrypt Sync Key
    8. Select Close Window
    9. To set the sync service, open the Codebook Settings window. Codebook -> Settings...
    10. Select the Sync tab on the Settings window.
    11. Click to open the Sync Service drop-down list and select the sync service that contains your data - Dropbox or Google Drive
    12. Start Sync: Sync menu > Start Sync

      You will be prompted to enter the Dropbox or Google Drive account. Make sure to use the account that contains your Codebook data. This will restore the data from the sync service to this device.

On windows

  • Restore Using a Printed Codebook Backup Code

    1. Start the Sync Key setup process. Sync menu > Setup Sync Key
    2. On the Setup Your Sync Key screen, select Yes to begin importing your Sync Key.
    3. Click Next
    4. The Import Sync Key screen will be displayed. Select Scan QR Code
    5. Click Next
    6. Point the camera at your Printed Backup Sync Key to capture the QR code. For help Scanning your QR Code - Trouble Scanning QR Code
    7. Click Process
    8. The Scan QR Code screen will be displayed. Enter the master password associated with the QR Code. This should be written on the printed Codebook Backup Code
    9. Click Process
    10. The Sync Key Imported screen will be displayed, click Next
    11. The Codebook Setup Complete screen will be displayed, click Done
    12. To set the sync service, open the Codebook Preferences window. File Menu -> Preferences
    13. Select the Sync tab on the Preferences window.
    14. Use the drop-down list to enable sync. Select the sync service that contains your data - Dropbox or Google Drive
    15. Click Save
    16. Start Sync: Sync menu > Sync with Google Drive or Dropbox

      You will be prompted to enter the Dropbox or Google Drive account. Make sure to use the account that contains your Codebook data. This will restore the data from the sync service to this device.

  • Restore Using a Word List

    1. Start the Sync Key setup process. Sync menu > Setup Sync Key
    2. On the Setup Your Sync Key screen, select Yes to begin importing your Sync Key.
    3. Click Next
    4. The Import Sync Key screen will be displayed. Select Enter word list
    5. Select Next
    6. Enter the 20 words that comprise your word list in order. Select Next
    7. The Sync Key Imported window will be displayed. Select Next
    8. The Codebook Setup Complete screen will be displayed, click Done
    9. To set the sync service, open the Codebook Preferences window. File Menu -> Preferences
    10. Select the Sync tab on the Preferences window.
    11. Use the drop-down list to enable sync. Select the sync service that contains your data - Dropbox or Google Drive
    12. Click Save
    13. Start Sync: Sync menu > Sync with Google Drive or Dropbox

      You will be prompted to enter the Dropbox or Google Drive account. Make sure to use the account that contains your Codebook data. This will restore the data from the sync service to this device.

  • Restore Using a Sync Key File

    1. Start the Sync Key setup process. Sync menu > Setup Sync Key
    2. On the Setup Your Sync Key screen, select Yes to begin importing your Sync Key.
    3. Click Next
    4. The Import Sync Key screen will be displayed. Select Sync Key file
    5. Select your Sync Key Backup file. It may be named Codebook.synckey.
    6. Enter the Master Password that was used when the backup sync key file was created.
    7. Select Import
    8. The Sync Key Imported screen will be displayed, click Next
    9. The Codebook Setup Complete screen will be displayed, click Done
    10. To set the sync service, open the Codebook Preferences window. File Menu -> Preferences
    11. Select the Sync tab on the Preferences window.
    12. Use the drop-down list to enable sync. Select the sync service that contains your data - Dropbox or Google Drive
    13. Click Save
    14. Start Sync: Sync menu > Sync with Google Drive or Dropbox

      You will be prompted to enter the Dropbox or Google Drive account. Make sure to use the account that contains your Codebook data. This will restore the data from the sync service to this device.