Skip to content

Commit 293e5ed

Browse files
authored
Revamp Install and Run pages for Windows and Linux (#208)
1 parent ed76efa commit 293e5ed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+599
-348
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,4 @@ node_modules/
1717
_gen/
1818
.hugo_build.lock
1919
.idea
20+
data/bibliography.json
Lines changed: 3 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
---
1+
---
22
title: Install and Run
33
aliases:
44
- /medley/using/build/
@@ -11,25 +11,9 @@ weight: 10
1111
type: docs
1212
---
1313

14-
You can install Medley on a variety of different computer systems.
15-
16-
17-
### Download and install from a release
18-
* [Running on Linux](./running-on-linux)
19-
* Packages for .deb distributions and source to build for others
20-
* [Running on Mac](./running-on-mac)
21-
* for MacOS
22-
* [Running on Windows](./running-on-win)
23-
* [Running on Windows with WSL](./running-on-wsl)
24-
25-
26-
Medley has a virtual machine architecture: there's a virtual machine implementation (called Maiko) and Lisp software that is compiled into instructions for it. The compiled code and memory images can be moved from one architecture to another -- only Maiko needs to be ported. Maiko has been substantially revised and modernized, so you can to run Medley on many different OSes and machine architectures.
27-
28-
See the [Maiko README](https://github.com/Interlisp/maiko#readme) and [Medley README](https://github.com/Interlisp/medley#readme) in their respective GitHub repository pages for more details on how to build and run them.
14+
Packaged releases of Medley are available for Linux (most recent distros), MacOS and Windows 10/11. Both x86_64 and Arm64 systems are supported (as well as Arm7 - e.g., Raspberry Pi - for Linux). Instructions for installing and running Medley on these platforms are linked below.
2915

30-
The current systems we've tested or for which we have confirmed reports can be found [in the Maiko github repository](https://github.com/Interlisp/maiko/tree/master/bin), including:
31-
* OS: FreeBSD, Linux, MacOS, Solaris, Windows (using WSL or CygWin)
32-
* CPU: arm7l, arm64, PowerPC, SPARC, i386, x86_64
16+
Medley is capable of running on a variety of other OSes including FreeBSD and Solaris as well as on other CPU architectures including i386, SPARC, PowerPC, and Risc-V. To install and run Medley on these platforms, you will need to build Medley (and its underlying virtual machine, *Maiko*) from the sources available in the Interlisp repos on github.com. Instructions for building Medley and Maiko can be be found on github in the [*readme* for Maiko](https://github.com/interlisp/maiko) and the [*readme* for Medley](https://github.com/interlisp/medley).
3317

3418

3519

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
---
2+
title: Install and Run on Linux
3+
weight: 20
4+
aliases:
5+
- /software/install-and-run/running-on-linux/
6+
type: docs
7+
---
8+
<style>.td-content blockquote { border-left: none; color: inherit; padding-left: 2rem;}</style>
9+
10+
*Note that these instructions do not apply to Linux distros running within Windows System For Linux (WSL). [Separate instructions are available for WSL here.](../windows/wsl).*
11+
12+
Medley installs and runs on most recent Linux distros (Alpine Linux is one exception). All that is strictly required is that the distro include an X Windows server. Most of the testing for Medley has been done on Ubuntu 20.04 and 22.04.
13+
14+
We also recommend that the Linux system have a web browser installed. A browser is not strictly necessary to run Medley, but several features of the system (e.g., displaying some user documentation) will not work without a browser installed.
15+
16+
## **Install Medley**
17+
18+
Medley can be installed on Linux in one of two configurations: *standard* and *local*.
19+
20+
* Standard installation is available only for Debian-based distros (e.g., Debian, Ubuntu, MX Linux, Mint Linux, etc.). It will install Medley into system directories (i.e., /usr/local/interlisp) and automatically install any prerequisite packages.
21+
* Local installation will install Medley into any user directory but any prerequisite packages must be installed manually.
22+
23+
Standard installations are ideal for users who want to explore Medley (including its system code) or to develop applications built on top of Medley. Standard installations are not good for users who want to modify the Medley system code, since that code is installed in protected locations.
24+
25+
### **Standard Installation (for Debian-based distros only)**
26+
27+
1. Download the installation file (.deb) for the latest release from the [Medley downloads site](https://online.interlisp.org/downloads/medley_downloads.html) from under the heading Linux/Standard/Linux. There are are separate .deb files for X86_64, Arm64 and Arm7 (e.g., Raspberry Pi) systems. Download the one that corresponds to your machine architecture. We will refer to the downloaded file as ***\<deb_filepath>***
28+
29+
<div align="center"><img alt="Medley Downloads Page" width=500 src="./images/downloads-page-linux-standard.png"><p>&nbsp;</p></div>
30+
31+
> >Alternatively, you can download the .deb files for the current or any previous release from the Medley Releases page on the Interlisp GitHub site. [Instructions for this can be found here](./linux-standard-from-github).
32+
33+
2. Into any Linux terminal, enter the following commands. This will install Medley and all prerequisite packages.
34+
35+
```
36+
ubuntu@oio:~$ sudo apt update
37+
ubuntu@oio:~$ sudo apt install -y <deb_filepath>
38+
```
39+
40+
### **Local Installation**
41+
1. Create a directory into which Medley will be installed. We will refer to this directory as ***\<install_dir>***
42+
43+
2. Download the release tar file (.tgz) for the latest release from the [Medley downloads site](https://online.interlisp.org/downloads/medley_downloads.html) from under the heading Linux/Local/Linux. There are are separate .tgz files for X86_64, Arm64 , and Arm7 (e.g., Raspberry Pi) systems. Download the one that corresponds to your machine architecture. We will refer to the downloaded file as ***\<tgz_filepath>***
44+
45+
<div align="center"><img alt="Medley Downloads Page" width=500 src="./images/downloads-page-linux-local.png"><p>&nbsp;</p></div>
46+
47+
> >Alternatively, you can download the .deb files for the current or any previous release from the Medley Releases page on the Interlisp GitHub site. [Instructions for this can be found here](./linux-local-from-github).
48+
49+
3. Untar ***<tgz_filepath>*** using the following command:
50+
```
51+
ubuntu@oio:~$ tar -xz -C <install_dir> -f <tgz_filepath>
52+
```
53+
4. Using the package manager for your distro (e.g., apt for Debian and Ubuntu distros), install the following packages:
54+
a) man-db
55+
b) xdg-utils
56+
c) tigervnc
57+
> ***Notes:***
58+
59+
> 4.1. If *xdg-utils* is not available for your Linux distro, then Medley will still run well, with the exception of a few sub-systems that require opening external (to Medley) files.
60+
61+
> 4.2. On Debian-based systems (including Ubuntu), the *tigervnc* package is not available. Instead install both the *tigervnc-standalone-server package* and the *tigervnc-xorg-extension* package.
62+
63+
## **Multiple Installations**
64+
**Standard Installations**
65+
Multiple standard installations are not possible. It is possible to have a single Standard installation alongside one or more Local installations.
66+
67+
**Local Installations**
68+
For local installations, you can install multiple copies of Medley (e.g. different releases). Simply place each installation into a separate ***install_dir***. And follow the install instructions above.
69+
70+
Each Medley installation so installed will operate independently of other Medley installations. The Medley system code for each installation will remain separate. However, in general the installations will share a single file system. So care must be taken to coordinate access to the file system.
71+
72+
## **Update Medley**
73+
To update any given Medley installation (e.g., to install a new release), download the updated .deb or .tgz installer file as described above. Then (re)run the appropriate install procedure as described above.
74+
75+
The chosen Medley installation will be updated. Any user files (i.e., files created by the user that are not part of the Medley distribution) in the Medley file system will remain intact.
76+
77+
## **Run Medley**
78+
Medley is started from any Linux terminal using the following commands.
79+
##### **Standard Installations**
80+
```
81+
medley <flags and options>
82+
```
83+
Example:
84+
<img alt="Start Medley Standard" width=500 src="./images/linux-standard.png">
85+
86+
##### **Local Installations**
87+
```
88+
cd <install_dir>
89+
./medley <flags and options>
90+
```
91+
Example:
92+
<img alt="Start Medley Standard" width=500 src="./images/linux-local.png">
93+
94+
Documentation for the `<flags and options>` to the `medley` command can be found [here](https://online.interlisp.org/downloads/man_medley.html)
95+
96+
For first-time users: `medley --vnc --apps --interlisp --noscroll` or, equivalently, `medley -v -a -e -n` is a good starting point. This will give you a fully populated Medley system, including the applications built on Medley such as Notecards and Rooms.
97+
98+
This will bring up the Medley environment in a separate Window on your Windows desktop. The Medley desktop and windows will all be contained within this Window as shown below.
99+
100+
![Medley window open on Windows desktop](./images/Medley-on-Linux.png)
101+
102+
103+
104+
## **Use Medley**
105+
Once Medley is up and running, see [here](../../using-medley/_index) for tips on how to navigate and use the Medley environment.
106+
107+
By default, Medley will use (creating, if necessary) a directory called *$HOME/il*. This will be used by the Medley system as its *LOGINDIR* as follows:
108+
109+
1. Medley will start up with *LOGINDIR* as its current connected directory.
110+
111+
2. Medley will load any personal init file from *LOGINDIR*/INIT or *LOGINDIR*/INIT.LCOM.
112+
113+
3. Medley will use *LOGINDIR*/vmem/ to store its virtual memory file(s).
114+
115+
The location of *LOGINDIR* can be changed using the `--logindir` option to `medley`. In particular, if you have multiple installations of Medley that you would like to keep completely separate, then you can use the `--logindir` option to ensure the *LOGINDIR* for each installation is unique.
116+
117+
To exit Medley, type ```(IL:LOGOUT)``` at any Exec window prompt.
118+
119+
153 KB
Loading
146 KB
Loading
161 KB
Loading
161 KB
Loading
28.8 KB
Loading
30 KB
Loading
236 KB
Loading

0 commit comments

Comments
 (0)