101 lines
2.4 KiB
Markdown
101 lines
2.4 KiB
Markdown
# LookAround
|
|
"I want to SSH into my laptop, but I keep forgetting its IP!!"
|
|
|
|
_Has this ever happened to you?_
|
|
|
|
```text
|
|
$ lookaround client
|
|
|
|
Found 3 peers:
|
|
11:11:11:11:11:11 = 192.168.1.101 `laptop`
|
|
22:22:22:22:22:22 = 192.168.1.102 `desktop`
|
|
33:33:33:33:33:33 = 192.168.1.103 `old-laptop`
|
|
```
|
|
|
|
LookAround is a Rust program for looking up your computers' MAC and IP addresses
|
|
within a LAN. There's no central server, so it's not a look-up, it's a look-around.
|
|
|
|
The client uses IP multicast to find servers within the
|
|
same multicast domain, similar to Avahi and Bonjour.
|
|
|
|
Systems self-identify by MAC address and nicknames. Public keys with
|
|
TOFU semantics are intended before v1.0.0.
|
|
|
|
## Installation
|
|
|
|
Use the Cargo package manager from [Rust](https://rustup.rs/) to install LookAround.
|
|
|
|
```bash
|
|
cargo install lookaround
|
|
```
|
|
|
|
To run the server as a normal user all the time,
|
|
put this systemd unit in `~/.config/systemd/user/lookaround.service`:
|
|
|
|
```ini
|
|
[Unit]
|
|
Description=LookAround
|
|
|
|
[Service]
|
|
ExecStart=/home/user/.cargo/bin/lookaround server --nickname my-desktop
|
|
|
|
[Install]
|
|
WantedBy=default.target
|
|
```
|
|
|
|
Then start the service, check that it's running okay, and enable it for
|
|
auto-start:
|
|
|
|
```bash
|
|
systemctl --user start lookaround
|
|
systemctl --user status lookaround
|
|
systemctl --user enable lookaround
|
|
```
|
|
|
|
## Usage
|
|
Run the server manually: (If you haven't installed it with systemd yet)
|
|
|
|
```bash
|
|
lookaround server --nickname my-desktop
|
|
```
|
|
|
|
Use `find-nick` to find an IP, or ping it, or SSH into it, or pull a file from it:
|
|
|
|
```bash
|
|
lookaround find-nick laptop
|
|
|
|
ping $(lookaround find-nick laptop)
|
|
|
|
ssh user@$(lookaround find-nick laptop)
|
|
|
|
# After starting `nc -l -p 9000 < some-file` on the laptop
|
|
nc $(lookaround find-nick laptop) 9000
|
|
``
|
|
|
|
Run a client to ping all servers in the same multi-cast domain:
|
|
|
|
```bash
|
|
lookaround client
|
|
```
|
|
|
|
Use a longer timeout if some servers need longer than 500 ms to respond:
|
|
|
|
```bash
|
|
lookaround client --timeout-ms 1000
|
|
```
|
|
|
|
## Contributing
|
|
Pull requests are welcome. This is a hobby project, so I may reject
|
|
contributions that are too big to review.
|
|
|
|
Use the [kazupon Git commit message convention](https://github.com/kazupon/git-commit-message-convention)
|
|
|
|
## License
|
|
[AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.html)
|
|
|
|
## This Git repo
|
|
This repo's upstream is https://six-five-six-four.com/git/reactor/lookaround.
|
|
It's mirrored on my GitHub, https://github.com/ReactorScram/lookaround
|
|
|
|
I don't use GitHub issues, so issues are in issues.md in the repo.
|