search

Dyalog / ride

Cross-platform IDE for Dyalog APL
https://dyalog.github.io/ride
MIT License
198 stars 29 forks source link

Zero footprint RIDE app is now included in 17.1 and 18.0 installation directories #1165

Open xpqz opened 9 months ago

xpqz commented 9 months ago

[Ported from Mantis 0018247]

Zero footprint RIDE app is now (38558) included in 17.1 and 18.0 installation directories

Now that we’ve added zero footprint RIDE to the installations of Dyalog 17.1 and 18.0 on all non-Windows platforms, I’ve written the following to describe how to use zfpr..

17.1 includes zfpr from RIDE 4.2 18.0 includes zfpr from RIDE 4.3 19.0 will include zfpr from RIDE 4.4

Zero footprint RIDE

Introduction

The RIDE client is supplied in two forms; the standalone client which requires installing, and as a zero footprint app which runs in recent browsers, and which the interpreter itself makes available to the web browser. It is possible to configure Dyalog APL so that it picks up the zero footprint RIDE app from an installed RIDE client, but from revision 38558 of Dyalog 17.1 and 18.0 onwards the zero footprint RIDE app is supplied as part of the installation on all non-Windows installations, and a suitable ride.ini file is created in $HOME/.dyalog.

Quick start guide

Assuming that the machine that the APL is running on is called aplsrv and that you wish to use port 8080, and to allow a browser request to come in from any address: RIDE_INIT=http:*:8080 dyalog then point your webbrowser to http://aplsrv:8080/

Description

To use zero footprint RIDE it is necessary to:

  1. Have the the zero footprint RIDE app installed on the machine where the Dyalog APL interpreter runs
  2. Create a RIDE ini file which contains the necessary configuration parameters to instruct the interpreter to make zero footprint RIDE app available, and details of where the app is located
  3. Define the RIDE_INIT configuration parameter to point to the RIDE ini file – and possibly to define some of the configuration of zero footprint RIDE.
  4. Point your browser to the correct machine/port number

The RIDE_INIT configuration parameter and the RIDE inifile between them must at minimum specify

  1. That the zero footprint RIDE app is to be offered by the interpreter
  2. The location of the app
  3. The port number on which the RIDE app is to be offered
  4. The addresses which the application it to be offered on

  5. The location of the RIDE app can only be specified in the RIDE inifile. Dyalog recommends that the port number and ip address range are defined in the RIDE_INIT configuration parameter as they are more likely to change. Note that if you wish to use an inifile other than $HOME/.dyalog/ride.ini then you will need to define its location using the CONFIG option for RIDE_INIT.

dyaandys commented 8 months ago

18.2 includes zfprR 4.4, 19.0 will include 4.5