Skip to content

Commit 3b58bfb

Browse files
authored
updates install instructions for debian (#675)
- Updated install instructions in allignment to: https://wiki.debian.org/DebianRepository/UseThirdParty - Markdown cleanup Signed-off-by: Toni Förster <toni.foerster@icloud.com>
1 parent 5fe8767 commit 3b58bfb

File tree

1 file changed

+20
-14
lines changed

1 file changed

+20
-14
lines changed

README.md

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@ sudo cp ../init/launchd/homebrew.mxcl.et.plist /Library/LaunchDaemons/homebrew.m
4343
sudo launchctl load -w /Library/LaunchDaemons/homebrew.mxcl.et.plist
4444
```
4545

46-
4746
Alternatively, a package is available in MacPorts:
4847

4948
```
@@ -62,14 +61,14 @@ sudo apt-get install et
6261

6362
Or see "Debian/Ubuntu" below to install and build from source (e.g., for ARM).
6463

65-
6664
### Debian
6765

68-
For debian, use our deb repo. For buster:
66+
For Debian, use our deb repo:
6967

7068
```
71-
echo "deb https://github.com/MisterTea/debian-et/raw/master/debian-source/ buster main" | sudo tee -a /etc/apt/sources.list.d/et.list
72-
curl -sSL https://github.com/MisterTea/debian-et/raw/master/et.gpg | sudo tee /etc/apt/trusted.gpg.d/et.gpg >/dev/null
69+
echo "deb [signed-by=/etc/apt/keyrings/et.gpg] https://mistertea.github.io/debian-et/debian-source/ $(grep VERSION_CODENAME /etc/os-release | cut -d= -f2) main" | sudo tee -a /etc/apt/sources.list.d/et.list
70+
sudo mkdir -m 0755 -p /etc/apt/keyrings # only if you're using Debian 11 or older
71+
curl -sSL https://github.com/MisterTea/debian-et/raw/master/et.gpg | sudo tee /etc/apt/keyrings/et.gpg >/dev/null
7372
sudo apt update
7473
sudo apt install et
7574
```
@@ -86,6 +85,7 @@ sudo dnf install et
8685
```
8786

8887
### FreeBSD
88+
8989
On FreeBSD, use:
9090

9191
```
@@ -110,14 +110,14 @@ zypper in EternalTerminal
110110

111111
Install dependencies:
112112

113-
* Fedora (tested on 25):
113+
- Fedora (tested on 25):
114114

115115
```
116116
sudo dnf install boost-devel libsodium-devel protobuf-devel \
117117
protobuf-compiler cmake gflags-devel libcurl-devel
118118
```
119119

120-
* Gentoo:
120+
- Gentoo:
121121

122122
```
123123
sudo emerge dev-libs/boost dev-libs/libsodium \
@@ -138,7 +138,7 @@ sudo make install
138138

139139
### Windows
140140

141-
Eternal Terminal works under WSL (Windows Subsystem for Linux). Follow the ubuntu instructions.
141+
Eternal Terminal works under WSL (Windows Subsystem for Linux). Follow the ubuntu instructions.
142142

143143
### Docker Image
144144

@@ -148,7 +148,7 @@ See [docker/README.md](docker/)
148148

149149
Verify that the client is installed correctly by looking for the `et` executable: `which et`.
150150

151-
Verify that the server is installed correctly by checking the service status: `systemctl status et`. On some operating systems, you may need to enable and start the service manually: `sudo systemctl enable --now et`.
151+
Verify that the server is installed correctly by checking the service status: `systemctl status et`. On some operating systems, you may need to enable and start the service manually: `sudo systemctl enable --now et`.
152152

153153
You are ready to start using ET!
154154

@@ -163,20 +163,25 @@ ET uses ssh for handshaking and encryption, so you must be able to ssh into the
163163
ET uses TCP, so you need an open port on your server. By default, it uses 2022.
164164

165165
Once you have an open port, the syntax is similar to ssh. Username is default to the current username starting the et process, use `-u` or `user@` to specify a different if necessary.
166+
166167
```
167168
et hostname (etserver running on default port 2022, username is the same as current)
168169
et user@hostname:8000 (etserver running on port 8000, different user)
169170
```
171+
170172
You can specify a jumphost and the port et is running on jumphost using `--jumphost` and `--jport`. If no `--jport` is given, et will try to connect to default port 2022.
173+
171174
```
172175
et hostname -jumphost jump_hostname (etserver running on port 2022 on both hostname and jumphost)
173176
et hostname:8888 --jumphost jump_hostname --jport 9999
174177
```
178+
175179
Additional arguments that et accept are port forwarding pairs with option `-t "18000:8000, 18001-18003:8001-8003"`, a command to run immediately after the connection is setup through `-c`.
176180

177181
Starting from the latest release, et supports parsing both user-specific and system-wide ssh config file.
178182
The config file is required when your sshd on server/jumphost is listening on a port which is not 22.
179183
Here is an example ssh config file showing how to setup when
184+
180185
- there is a jumphost in the middle
181186
- sshd is listening on a port which is not 22
182187
- connecting to a different username other than current one.
@@ -212,7 +217,7 @@ cmake ../
212217
make -j$(nproc) && sudo make install
213218
```
214219

215-
To run an `et` server for testing, run `./etserver`. To run an `et`
220+
To run an `et` server for testing, run `./etserver`. To run an `et`
216221
server daemon persistently across reboots:
217222

218223
```
@@ -249,10 +254,10 @@ sudo cp ../etc/et.cfg /etc/
249254

250255
Once built, the binary only requires `libprotobuf-dev`.
251256

252-
253257
### CentOS 7
254258

255259
Install dependencies:
260+
256261
```
257262
sudo yum install epel-release
258263
sudo yum install cmake3 boost-devel libsodium-devel protobuf-devel \
@@ -261,12 +266,14 @@ sudo yum install cmake3 boost-devel libsodium-devel protobuf-devel \
261266
```
262267

263268
Install scl dependencies
269+
264270
```
265271
sudo yum install centos-release-scl
266272
sudo yum install devtoolset-11 devtoolset-11-libatomic-devel rh-git227
267273
```
268274

269275
Download and install from source ([see #238 for details](https://github.com/MisterTea/EternalTerminal/issues/238)):
276+
270277
```
271278
git clone --recurse-submodules --depth 1 https://github.com/MisterTea/EternalTerminal.git
272279
cd EternalTerminal
@@ -280,7 +287,7 @@ sudo cp ../etc/et.cfg /etc/
280287

281288
Find the actual location of et:
282289

283-
which etserver
290+
which etserver
284291

285292
Correct the service file (see [#180](https://github.com/MisterTea/EternalTerminal/issues/180) for details).
286293

@@ -290,7 +297,7 @@ sudo sed -ie "s|ExecStart=[^[:space:]]*[[:space:]]|ExecStart=$(which etserver) |
290297

291298
Alternativelly, open the file /etc/systemd/system/et.service in an editor and correct the `ExectStart=...` line to point to the correct path of the `etserver` binary.
292299

293-
ExecStart=/usr/local/bin/etserver --cfgfile=/etc/et.cfg
300+
ExecStart=/usr/local/bin/etserver --cfgfile=/etc/et.cfg
294301

295302
Reload systemd configs:
296303

@@ -317,4 +324,3 @@ If you have any problems with installation or usage, please [file an issue on gi
317324
- Jason Gauci: https://github.com/MisterTea
318325
- Ailing Zhang: https://github.com/ailzhang
319326
- James Short: https://github.com/jshort
320-

0 commit comments

Comments
 (0)