Architect – Architect Server

Documentation: Introduction

Mon, 01 Jan 0001 00:00:00 +0000

Architect Server allows you to launch and connect to R sessions that are running on a remote server, straight from Architect. Once connected to a remote R session, users have seamless access to all the Architect’s local features, such as integrated data visualization tools and streamlined code evaluation.

Documentation: Installation

Mon, 01 Jan 0001 00:00:00 +0000

Installation from repositories

The easiest way to install Architect Server on Ubuntu is to use our package repository. Follow the instructions for your version of Ubuntu.

Bionic (Ubuntu 18.04)

Stable release

sudo apt update
sudo apt install gpg apt-transport-https ca-certificates wget software-properties-common
wget -qO - https://getarchitect.io/repo-key.gpg | sudo apt-key add -
sudo add-apt-repository 'deb [arch=amd64] https://apt.getarchitect.io/bionic/ bionic main'
sudo apt install architect-server

Snapshot release

Note: this repository provides development versions of Architect, use with care.

sudo apt update
sudo apt install gpg apt-transport-https ca-certificates wget software-properties-common
wget -qO - https://getarchitect.io/repo-key.gpg | sudo apt-key add -
sudo add-apt-repository 'deb [arch=amd64] https://apt.getarchitect.io/bionic-snapshot/ bionic main'
sudo apt install architect-server

Focal (Ubuntu 20.04)

Stable release

sudo apt update
sudo apt install gpg apt-transport-https ca-certificates wget software-properties-common
wget -qO - https://getarchitect.io/repo-key.gpg | sudo apt-key add -
sudo add-apt-repository 'deb [arch=amd64] https://apt.getarchitect.io/focal/ focal main'
sudo apt install architect-server

Snapshot release

Note: this repository provides development versions of Architect, use with care.

sudo apt update
sudo apt install gpg apt-transport-https ca-certificates wget software-properties-common
wget -qO - https://getarchitect.io/repo-key.gpg | sudo apt-key add -
sudo add-apt-repository 'deb [arch=amd64] https://apt.getarchitect.io/focal-snapshot/ focal main'
sudo apt install architect-server

Jammy (Ubuntu 22.04)

Stable release

sudo apt update
sudo apt install gpg apt-transport-https ca-certificates wget software-properties-common
wget -qO - https://getarchitect.io/repo-key.gpg | sudo apt-key add -
sudo add-apt-repository 'deb [arch=amd64] https://apt.getarchitect.io/jammy/ jammy main'
sudo apt install architect-server

Snapshot release

Note: this repository provides development versions of Architect, use with care.

sudo apt update
sudo apt install gpg apt-transport-https ca-certificates wget software-properties-common
wget -qO - https://getarchitect.io/repo-key.gpg | sudo apt-key add -
sudo add-apt-repository 'deb [arch=amd64] https://apt.getarchitect.io/jammy-snapshot/ jammy main'
sudo apt install architect-server

Manual installation

Alternatively, .deb and .rpm package files are available for Architect Server on our downloads page.

Ubuntu

Download the .deb file, then type in the terminal:

dpkg -i XXX.deb

where ‘XXX.deb’ is the name of the downloaded .deb file.

CentOS

Download the .rpm file, then type in the terminal:

rpm -i XXX.rpm

where ‘XXX.rpm’ is the name of the downloaded .rpm file.

Documentation: Configuration

Mon, 01 Jan 0001 00:00:00 +0000

Architect server installs a configuration file under /etc/architect-server/architect-server.properties.

There is currently a single property that can be set in the file, namely the port of the RMI registry that is used by architect-server:

port=1099

The default value is: port=1099. If you edit this value, please restart architect-server using

sudo service architect-server restart

for the change to have effect.

Documentation: Client Configuration

Mon, 01 Jan 0001 00:00:00 +0000

Basic Configuration

Inside Architect, type Ctrl + 3 to pull up the Quick Search menu, then search for Run Configurations. Click on R Remote Console in the left menu, then click the ’new configuration' button () to define a new run configuration.

Then, fill in the address of your server and your credentials. A sample completed configuration looks as follows.

The Address field is composed of the host name (my.hostname.com) and the remote session name (remote-session-name1 in the example). A remote session name is an arbitrary name to identify the session. It allows one to define multiple different ‘R Remote Console’ configurations for different sessions on the same server (same host name). These names will also be displayed on top of the consoles which allows to distinguish between the different sessions and to easily switch back and forth from one session to another.

We recommend checking the Tunnel connections to R engine through SSH box, which secures the connection and does not require opening an extra port on the firewall. Note that Architect Server assumes that users have credentials to access the remote server over SSH.

Once configured, launch the newly created configuration choosing it via the configuration selector black arrow ().

In the above screenshot, we’ve named this configuration ‘my_generic_connection’. Naming a remote session allows users to have multiple uniquely named remote configurations defined. Above, the sessions ‘my_generic_connection’ and ‘my_generic_connection2’ could be run concurrently.

We can go one step further and label a configuration as a ‘favorite’ in the Common tab.

This places the selected configuration in a favorites list at the top of the run configurations dropdown menu ().

Remote R Help

Browsing an R help directory on a remote server is possible via the Remote Systems Explorer (RSE) eclipse plugin.

Install the RSE plugin from the eclipse marketplace: Help > Eclipse Marketplace…
Open the Remote Systems view : Window > Show View > Other… then under Remote Systems select Remote Systems.
Create a new connection by clicking the ’new connection’ button () and use the dialog to configure the remote endpoint. If the remote server is a *nix based system, we suggest to select use ssh only.
Next, configure a remote R environment for your remote R console.

follow steps 1-5 on installing different versions of R
on step 5, instead use the dropdown next to the Add… button to select Add Remote.
configure the remote in the following way:

where HOST should correspond to the host in the RSE connection

Launch your remote R console. After the index has finished updating ([INFO] Updating the R environment index started), restart the remote R console. The remote help view should now be working.