Advanced Topics¶

In this section we cover some more advanced topics around installation and configuration.

Config file¶

The config file is created the first time you run python -m remo_app init when using pip, or when first launching Remo using Docker. It gets stored in the .remo folder.

Here are the main editable fields:

{
  "db_url": "postgres://remo:[email protected]:5432/remo",
  "port": "8123",
  "viewer": "electron"
}

and their usage:

port: port where remo will be served
db_url: address where the database lives. If using Docker, you have the option to have the Database running elsewhere
viewer: see viewer section below.

Changing some values would require running again python -m remo_app update in order for the changes to be processed.

Viewer¶

Accepted values:

electron
browser
jupyter

By default, if Remo was installed via pip, it uses Electron to run the app. This allows for more vertical space compared to using Remo in a browser.

If you prefer to access Remo from a browser (Remo was tested with Chrome), you can directly browse to where Remo is being served (default: localhost:8123). You can also change the value of the viewer in the config file to browser, and on launch a browser window will pop open.

Remo folder¶

The .remo folder is first created when installing Remo and it's located in HOME_DIRECTORY/.remo/. Location of your HOME directory depends upon your specific OS system.

You shouldn't really need to touch the folder to use Remo, except if you want to add some configuration to the Config file.

Database¶

Remo currently supports only PostgreSQL. If using a Docker installation, you have the option to use an external PostgreSQL server

Support for MySQL is in the plans at some point.

Installation issues¶

In this section we will collect some troubleshooting steps that can help with installation issues.

In case you are stuck, feel free to check existing issues on the discuss forum or open a new discussion.

Ubuntu¶

On a fresh Ubuntu machine, depending on what's installed you may need to install gcc and python3-dev packages.

PostgreSQL Installation¶

When doing python -m remo_app init, the script will try to automatically install PostgreSQL. If the installation fails, you can try to:

Install PostgreSQL manually, e.g. as described here
Run again python -m remo_app init.

Remo version¶

You can check your version of remo by either:

pointing the mouse to the Remo icon within the webapp
calling python -m remo_app --version

medium_width_pic