Skip to content

Commit

Permalink
Port troubleshooting.md fixes from old PR 51
Browse files Browse the repository at this point in the history
An older version of these were incorporated when merging PR 63 - update
to the edited version from PR 51.

Co-authored-by: KronosTheLate <[email protected]>
  • Loading branch information
c42f and KronosTheLate committed Jul 16, 2024
1 parent 24a5901 commit e89cf05
Showing 1 changed file with 18 additions and 18 deletions.
36 changes: 18 additions & 18 deletions docs/src/howto.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,28 +128,28 @@ connect_remote();
```
which will allow you to use `@remote` without the REPL mode.

## Troubleshooting

This section contains errors that have been seen before, and how they were fixed. The goal is that solutions to common problems are found here.
By "local REPL" a REPL running on the same computer as the host is meant. By "remote REPL", a REPL running on a different computer is meant.

### IOError: connect: connection refused (ECONNREFUSED)
## Troubleshooting connection issues
Sometimes errors will be encountered. This section aims to show some errors experienced by users, and what the underlying problem was. We will use some terms in this section, introduced in the table below.
|Term|Explanation|
|---|---|
|"local REPL"|a REPL running on the same computer as the host. This could mean connecting two julia instances running on the same computer.|
|"remote REPL"|a REPL running on a different computer than the host.|
|"address"|a placeholder for the address you connect to, typically an IP-address. Examples of what an actual address could look like include "[email protected]" and "[email protected]".|

### Error: `IOError: connect: connection refused (ECONNREFUSED)`
This error has been encountered when
1) Running `connect_repl()`, while attempting to connect to a local REPL. The problem was that no local REPL had previously run `serve_repl()`. To fix this, run `serve_repl()` in the local REPL.
2) Running `connect_remote()`, while attempting to connect to a local REPL. The problem was that no local REPL had previously run `serve_repl()`. To fix this, run `serve_repl()` in the local REPL.
3) Running `connect_remote()`, while attempting to connect to a remote REPL. The problem was that no address was provided. To fix this, pass an adress as a string to `connect_remote`, as in `connect_remote("[email protected]")`
1) Running `connect_repl()` or `connect_remote()`, while attempting to connect to a local REPL. The problem was that no local REPL had previously run `serve_repl()`. To fix this, run `serve_repl()` in the local REPL.
2) Running `connect_remote()`, while attempting to connect to a remote REPL. The problem was that no address was provided. To fix this, pass an address as a string to `connect_remote`, as in `connect_remote("address")`

### RemoteREPL stream was closed while reading header
This error has been encountered when
1) Running `connect_remote("[email protected]")`, while attempting to connect to a remote REPL. The problem was that the remote REPL had not previously run `serve_repl()`. To fix this, run `serve_repl()` in the remote REPL.
2) Running `connect_repl("[email protected]")`, while attempting to connect to a remote REPL. The problem was that the remote REPL had not previously run `serve_repl()`. To fix this, run `serve_repl()` in the remote REPL.
### Error: `RemoteREPL stream was closed while reading header`
This error has been encountered when running `connect_remote("address")` or `connect_repl("address")`, while attempting to connect to a remote REPL. The problem was that the remote REPL had not previously run `serve_repl()`. To fix this, run `serve_repl()` in the remote REPL.

### Bad owner or permissions on /home/username/.ssh/config
### Error: `Bad owner or permissions on /home/username/.ssh/config`
This error is raised by [this](https://github.com/openssh/openssh-portable/blob/947a3e829a5b8832a4768fd764283709a4ca7955/readconf.c#L1711) line of code, from OpenSSH.
The requirements translates to that "the config file must be owned by root or by the user running the ssh and can not be writable by any group or other users."
(Quoted from [this](https://superuser.com/questions/1212402/bad-owner-or-permissions-on-ssh-config-file) thread). The fix is therefore to remove write premissions for
any group or other users. On a linux system, this is acomplished by running the following code.
(Quoted from [this](https://superuser.com/questions/1212402/bad-owner-or-permissions-on-ssh-config-file) thread). The fix is therefore to remove write permissions for
any group or other users. On a linux system, this is accomplished by running the following code.
```
chmod go-w /home/username/.ssh/config
chmod go-w /home/username/.ssh/*
```
If you are using a different operating system, please google how to remove write premissions on files, and try to do the same thing.
If you are using a different operating system, please google how to remove write permissions on files, and try to do the same thing.

0 comments on commit e89cf05

Please sign in to comment.