Setup Instructions

The program can be installed with pip from the git repository:

# Requires python >= 3.10
git clone
# Frontend files need to be separately built
cd swift_browser_ui_frontend && npm install -g pnpm@7 && pnpm install && pnpm run build && cd ..
pip install .


The program uses external services that need to be present in order to enable all functionality, like sharing. These additional services can be found from the git repositories. The instructions for getting the services up and running can be found in their respective repositories, and partly under the Deployment section.

Environment Setup


The command line arguments can also be configured as environment variables, the environment variable syntax is documented in the python click documentation [1] , the shape of a variable could take the following forms:

  • BROWSER_$ARGUMENT - affects every command;
  • BROWSER_$SUBCOMMAND_$ARGUMENT - affects subcommands e.g. start, install.

Variables are depicted in the table below:

Environment variable Default Description    
BROWSER_START_AUTH_ENDPOINT_URL   URL to use as the Openstack authentication backend    
BROWSER_START_PORT 8080 Port that the service will listen    
BROWSER_START_SET_ORIGIN_ADDRESS   Authentication return address to which WebSSO should redirect    
BROWSER_START_HAS_TRUST   Flag if the program is listed on the trusted_dashboards    
BROWSER_START_SHARING_ENDPOINT_URL   external URL for the container sharing backend    
BROWSER_START_REQUEST_ENDPOINT_URL   external URL for the shared access request backend    
BROWSER_START_RUNNER_ENDPOINT   internal URL for the upload, copy, download runner    
SWIFT_UI_SHARING_REQUEST_TOKEN   Token for signing the internal sharing & request API requests    
BROWSER_START_RUNNER_EXT_ENDPOINT   external URL for the upload runner service    
BROWSER_START_SHARING_INT_ENDPOINT_URL   internal URL / hostname of the sharing API    
BROWSER_START_REQUEST_INT_ENDPOINT_URL   internal URL / hostname of the request API    
LOG_LEVEL   set logging level e.g. INFO, DEBUG    


Authentication endpoint can also be specified with any openrc file, which can be usually downloaded from Openstack. The setup script from Openstack might ask for your password, but this isn’t a required input and can be left empty.

Example environment variable files

For the Pouta test environment with NGINX TLS termination proxy in use:

export BROWSER_START_PORT="8081"

For the Pouta production environment for testing unsecurely without trust:


Setting up TLS termination proxy

The backend can be run in secure mode, i.e. with HTTPS enabled, but for scaling up a TLS termination proxy is recommended. Setting up TLS termination is outside the scope of this documentation, but a few useful links are provided along with the necessary configs regarding this service. [2] [3]

Scaling up the service

The service runs in a single-threaded mode, since the library that’s used for providing the back-end isn’t multi-threaded. Therefore to completely use up a server’s resources a multi-processed approach must be chosen. The easiest way to do this is to set up a reverse proxy, which can be run in the same server that acts as the TLS endpoint.

The aiohttp documentation already gives us directions for the set-up [4] so they won’t be provided here. In its current state the project should be configured to use TCP sockets in NGINX, so they’re the directions to use in the aforementioned link. Also change the server run command to enable running the project as follows:

command=swift-browser-ui start --port=808%(process_num)s