Skip to content

Commit b784f45

Browse files
committed
Issue #58: osPrereqs docs finished? [ci skip]
1 parent 0e25915 commit b784f45

File tree

4 files changed

+80
-74
lines changed

4 files changed

+80
-74
lines changed

Diff for: docs/osPrereqs/OSX10.9.md

+20-4
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,38 @@
11
# GsDevKit prerequisites for OS X10.9
22

3+
1. [Install Basic Prerequisites (required)](#install-basic-prerequisites-required)
4+
3. [Install ssh (optional)](#install-ssh-optional)
5+
4. [X11 Client (optional)](#install-x11-client-optional)
6+
2. [osPrereqs Installation Script (optional)](#osPrereqs-installation-script-optional)
7+
8+
If you are undecided about whether or not you should install the optional packages, read the section on [Client/Server Configurations][4].
9+
10+
##Install Basic Prerequisites (required)
11+
312
The following programs must be installed on OS X 10.9 for GsDefKit and tODE to function:
413

514
- git
615
- wget
716

8-
To install git, [follow these instructions][2].
17+
To install `git`, [follow these instructions][2].
918

1019
To install `wget`, first [install brew][1] then:
1120

1221
```
1322
brew install wget
1423
```
1524

16-
###X11
17-
X11 is not required for GsDevKit or Pharo, however, if you want to use [vsd][4], then you need to [install X11][3].
25+
##Install ssh (optional)
26+
ssh is installed on Mac OS X by default, so no additional steps are needed.
27+
28+
###Install X11 Client (optional)
29+
To install X11 [follow these instructions][3].
30+
31+
###osPrereqs Installation Script (optional)
32+
Currently the [osPrereqs script][5] does not support OS X.
1833

1934
[1]: http://coolestguidesontheplanet.com/setting-up-os-x-mavericks-and-homebrew/
2035
[2]: http://git-scm.com/book/en/v2/Getting-Started-Installing-Git#Installing-on-Mac
2136
[3]: http://xquartz.macosforge.org/landing/
22-
[4]: http://gemtalksystems.com/products/vsd/
37+
[4]: osPrereqs.md#clientserver-configurations
38+
[5]: ../../bin/osPrereqs

Diff for: docs/osPrereqs/osPrereqs.md

+22
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,18 @@ I recommend that you install the two optional packages [SSH](#ssh) and [X11 Clie
2424
If you are undecided, then please read the section on [Client/Server Configurations](#clientserver-configurations) to help you make up your mind.
2525

2626
###SSH
27+
Platform-specific installation instructions:
28+
29+
- [ssh for Ubuntu 12.04][65]
30+
- [ssh for Ubuntu 14.04][66]
31+
- [ssh for OS X10.9][67]
2732

2833
###X11 Client
34+
Platform-specific installation instructions:
35+
36+
- [X11 Client for Ubuntu 12.04][75]
37+
- [X11 Client for Ubuntu 14.04][76]
38+
- [X11 Client for OS X10.9][77]
2939

3040
##Client/Server Configurations
3141
A [GemStone server][8] is made up of several different processes:
@@ -86,3 +96,15 @@ Depending upon network latency and whether or not you are comfortable opening po
8696
[15]: http://gemtalksystems.com/licensing/#CWELicensing
8797
[16]: ../x11ForwardingForRemoteDisplays.md#x11-forwarding-for-remote-servers
8898
[17]: ../portForwardingForRemoteLogins.md#using-port-forwarding-for-remote-gemstone-servers
99+
100+
[55]: ubuntu12.04.md
101+
[56]: ubuntu14.04.md
102+
[57]: OSX10.9.md
103+
104+
[65]: ubuntu12.04.md#install-ssh-optional
105+
[66]: ubuntu14.04.md#install-ssh-optional
106+
[67]: OSX10.9.md#install-ssh-optional
107+
108+
[75]: ubuntu12.04.md#install-x11-client-optional
109+
[76]: ubuntu14.04.md#install-x11-client-optional
110+
[77]: OSX10.9.md#install-x11-client-optional

Diff for: docs/osPrereqs/ubuntu12.04.md

+20-34
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,11 @@
11
# GsDevKit prerequisites for Ubuntu 12.04
2-
It is recommended that you [Install ssh (optional)](#install-ssh-optional), since you can [run a script to the install prerequisite packages](#osPrereqs-bash-script).
32

4-
If you decide not to [run the script](#osPrereqs-bash-script), then following the manual instrructions in each section:
5-
6-
3. [Install ssh (optional)](#install-ssh-optional)
7-
- [osPrereqs bash script](#osPrereqs-bash-script)
83
1. [Install Basic Prerequisites (required)](#install-basic-prerequisites-required)
9-
2. [Install X11 Client (optional)](#install-x11-client-optional)
10-
11-
##Install ssh (optional)
12-
I recommend that you start by [installing ssh][2] on your server.
13-
Besides making it possible to use to use [X11 forwarding][1], it makes life working on your server much easier being able to use `ssh` for access and `scp` for moving files back an forth.
14-
Keep in mind that `ssh` is not required, so read up on the web about [best practices using ssh][4] before installing:
15-
16-
```
17-
sudo apt-get -y update
18-
sudo apt-get -y install openssh-client
19-
sudo apt-get -y install openssh-server
20-
```
21-
22-
If you have installed `ssh`, you can log into your server with `ssh` and continue with the installation steps.
23-
24-
###osPrereqs bash script
25-
If you have installed `ssh` and you've got a checkout of gsDevKit on your server, you can use scp to copy the [osPrereqs script][3] from your server to the Ubunutu 12.04 box and save copy and pasting.
26-
27-
The following script copys `osPrereqs`, logs into your vm and installs the [basic prerequisites](#install-basic-prerequisites) and the [X11 client](#install-x11-client):
4+
3. [Install ssh (optional)](#install-ssh-optional)
5+
4. [X11 Client (optional)](#install-x11-client-optional)
6+
2. [osPrereqs Installation Script (optional)](#osPrereqs-installation-script-optional)
287

29-
```
30-
scp $GS_HOME/bin/osPrereqs [email protected]:/home/notroot
31-
ssh 192.168.100.132 -l notroot
32-
./osPrereqs -X -o ubuntu12.04
33-
```
8+
If you are undecided about whether or not you should install the optional packages, read the section on [Client/Server Configurations][1].
349

3510
##Install Basic Prerequisites (required)
3611

@@ -53,16 +28,27 @@ sudo apt-get -y install pstack
5328
sudo /bin/su -c "echo 'kernel.yama.ptrace_scope = 0' >>/etc/sysctl.d/10-ptrace.conf"
5429
```
5530

56-
##X11 Client (optional)
57-
If you want run the Pharo client using [X11 forwarding][1] with `ssh`, then you need to install the **X11 client**:
31+
##Install ssh (optional)
32+
Before installing [ssh][2] on your server, read up on the web about [best practices using ssh][4].
33+
34+
```
35+
sudo apt-get -y update
36+
sudo apt-get -y install openssh-client
37+
sudo apt-get -y install openssh-server
38+
```
39+
40+
##Install X11 Client (optional)
5841

5942
```
6043
sudo apt-get -y install libgl1-mesa-dev:i386
6144
sudo apt-get -y install libxcb-dri2-0:i386
6245
```
63-
64-
[1]: http://unix.stackexchange.com/questions/12755/how-to-forward-x-over-ssh-from-ubuntu-machine
65-
[2]: https://help.ubuntu.com/12.04/serverguide/openssh-server.html
46+
47+
###osPrereqs Installation Script (optional)
48+
The [osPreregs script][3] is a bash script that can be used to install the prerequisites (including optional packages).
49+
50+
[1]: osPrereqs.md#clientserver-configurations
51+
[2]: https://help.ubuntu.com/14.04/serverguide/openssh-server.html
6652
[3]: ../../bin/osPrereqs
6753
[4]: http://www.cyberciti.biz/tips/linux-unix-bsd-openssh-server-best-practices.html
6854

Diff for: docs/osPrereqs/ubuntu14.04.md

+18-36
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,11 @@
11
# GsDevKit prerequisites for Ubuntu 14.04
2-
It is recommended that you [Install ssh (optional)](#install-ssh-optional).
3-
Besides the obvious advantages of secure remote logins and secure remote file copying, ssh gives you flexibility to:
4-
- run tODE locally and log into remote servers via **ssh port forwarding**
5-
- run tODE on remote server and host display on local X server via **ssh X11 forwarding**
6-
- use the osprereqs script to install the platform prerequisites
72

8-
If you decide not to [run the script](#osPrereqs-bash-script), then following the manual instructions in each section:
9-
10-
3. [Install ssh (optional)](#install-ssh-optional)
11-
- [osPrereqs bash script](#osPrereqs-bash-script)
123
1. [Install Basic Prerequisites (required)](#install-basic-prerequisites-required)
13-
2. [X11 forwarding](#install-x11-forwarding-optional)
14-
15-
##Install ssh (optional)
16-
I recommend that you start by [installing ssh][2] on your server.
17-
Besides making it possible to use to use [X11 forwarding][1], it makes life working on your server much easier being able to use `ssh` for access and `scp` for moving files back an forth.
18-
Keep in mind that `ssh` is not required, so read up on the web about [best practices using ssh][4] before installing:
19-
20-
```
21-
sudo apt-get -y update
22-
sudo apt-get -y install openssh-client
23-
sudo apt-get -y install openssh-server
24-
```
25-
26-
If you have installed `ssh`, you can log into your server with `ssh` and continue with the installation steps.
27-
28-
###osPrereqs bash script
29-
If you have installed `ssh` and you've got a checkout of gsDevKit on your server, you can use scp to copy the [osPrereqs script][3] from your server to the Ubunutu 14.04 box and save copy and pasting.
30-
31-
The following script copys `osPrereqs`, logs into your vm and installs the [basic prerequisites](#install-basic-prerequisites) and the [X11 client](#install-x11-client):
4+
3. [Install ssh (optional)](#install-ssh-optional)
5+
4. [X11 Client (optional)](#install-x11-client-optional)
6+
2. [osPrereqs Installation Script (optional)](#osPrereqs-installation-script-optional)
327

33-
```
34-
scp $GS_HOME/bin/osPrereqs [email protected]:/home/notroot
35-
ssh 192.168.100.132 -l notroot
36-
./osPrereqs -X -o ubuntu14.04
37-
```
8+
If you are undecided about whether or not you should install the optional packages, read the section on [Client/Server Configurations][1].
389

3910
##Install Basic Prerequisites (required)
4011

@@ -56,16 +27,27 @@ sudo apt-get -y install pstack
5627
sudo /bin/su -c "echo 'kernel.yama.ptrace_scope = 0' >>/etc/sysctl.d/10-ptrace.conf"
5728
```
5829

59-
##X11 forwardingIf you want run the Pharo client using [X11 forwarding][1] with `ssh`, then you need to install the **X11 client**:
30+
##Install ssh (optional)
31+
Before installing [ssh][2] on your server, read up on the web about [best practices using ssh][4].
32+
33+
```
34+
sudo apt-get -y update
35+
sudo apt-get -y install openssh-client
36+
sudo apt-get -y install openssh-server
37+
```
38+
39+
##Install X11 Client (optional)
6040

6141
```
6242
sudo apt-get -y install libgl1-mesa-dev:i386
6343
sudo apt-get -y install libxcb-dri2-0:i386
6444
```
6545

66-
[1]: http://unix.stackexchange.com/questions/12755/how-to-forward-x-over-ssh-from-ubuntu-machine
46+
###osPrereqs Installation Script (optional)
47+
The [osPreregs script][3] is a bash script that can be used to install the prerequisites (including optional packages).
48+
49+
[1]: osPrereqs.md#clientserver-configurations
6750
[2]: https://help.ubuntu.com/14.04/serverguide/openssh-server.html
6851
[3]: ../../bin/osPrereqs
6952
[4]: http://www.cyberciti.biz/tips/linux-unix-bsd-openssh-server-best-practices.html
7053

71-

0 commit comments

Comments
 (0)