Skip to content


Table of Contents

CREATE TRE Egress Portal Guide

1. Accessing the Egress App

To request data egress please access any of the researcher's VMs associated with your project and click on the “Data_Egress_Request” icon.

2. Egress Request Process

  1. Copy the files you intend to egress to the project directory on your TRE project Virtual Desktop.


  1. Launch the app and click on "Show File Picker" to select the desired file.


  1. Complete the "About this data…" section providing all necessary details and then hit "Submit Request."


  1. Now you can see the progress and status of the egress request.


3. Egress Approval and Rejection Process

  1. The egress authority will receive an email notification of the new data egress request.


  1. Log in to the TRE project, launch the Egress App, and under the tasks tab a list of egress requests along with an "Approve" button will be displayed.


  1. Review the egress file. If it meets the criteria, approve it. An email containing a Verification Pin valid for 15 minutes will be sent to the egress authority.


  1. Verify the pin to confirm approval.



  1. Egress request can also be rejected.
  2. The egress status will change to “Complete.”


  1. The user who requested the egress will receive a confirmation email. The egressed file will be copied to the RDS share accessible outside the TRE project.



4. Access Logs

  1. Navigate to the "Logs" tab. Here you'll find the Audit logs containing detailed records of all egress requests offering transparency and traceability.


Thank you for taking the time to review this guide. We are committed to ensuring that you have a smooth and efficient experience. In case of any challenges, uncertainties, or issues encountered while following this guide do not hesitate to reach out for support. For immediate assistance please contact: - Email: - Support Team Email:


1. Obtaining an SSH Key

1.1 Windows

  1. To generate an SSH key on Windows, use WinSCP which includes PuTTYgen:
  2. Download WinSCP from, for KCL laptops you can find it in the software centre.
  3. Install WinSCP, including PuTTYgen.
  4. Launch PuTTYgen from the Start menu or WinSCP tools.


    {PuTTYgen} * Click "Generate" and move your mouse over the blank area.

    {PuTTYgen} * Create and save a passphrase for your keys.

    {PuTTYgen} * Save the public and private keys. * Share the public key with us via email ( including your TRE project name.


1.2 macOS and Linux

  1. To generate an SSH key on macOS and Linux, use Terminal:
  2. Open Terminal.
  3. Run ssh-keygen -t rsa -b 4096.
  4. Accept the default file location or specify a different one.
  5. Enter a passphrase for your SSH key.
  6. The SSH keys will be saved in the specified or default ~/.ssh directory.

    {MacOS/Linux} * Share your public key by running cat ~/.ssh/ and email it to us ( with your TRE project name.

2. Installing SFTP Clients

2.1 Windows

  1. Use WinSCP as an SFTP client:
  2. Launch WinSCP and open the Login dialog.

    {WinSCP} * Fill in the Host name * Fill User name (this will be provided). * Click "Advanced..." and go to SSH > Authentication. * Select ... and add your private key file.

    {WinSCP} * Click "Login" to start the SFTP session.


2.2 macOS

  1. Install Cyberduck for macOS:
  2. Download Cyberduck from
  3. Install Cyberduck and open it.
  4. Click "Open Connection" and select SFTP.
  5. Enter the server details and select your private key.

2.3 Linux

  1. Use the built-in SFTP client in Terminal:
  2. Open Terminal.
  3. Run sftp -i /path/to/private_key user@hostname.
  4. Replace the placeholders with your private key path, username, and hostname.
  5. Use commands like get, put, and ls to transfer files.


  1. The private key file provided here should match the public key you've previously sent for access setup.
  2. We can incorporate an additional layer of security to the SFTP account by specifying the source IP address if required.