-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
124 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
name: CI | ||
on: [push] | ||
jobs: | ||
lint: | ||
name: lint | ||
runs-on: ubuntu-22.04 | ||
steps: | ||
- name: Install Rust | ||
uses: actions-rs/toolchain@v1 | ||
with: | ||
toolchain: stable | ||
override: true | ||
components: rustfmt, clippy | ||
|
||
- name: checkout code | ||
uses: actions/checkout@v1 | ||
|
||
- name: lint | ||
run: make lint | ||
|
||
tests: | ||
name: tests | ||
runs-on: ${{ matrix.os }} | ||
strategy: | ||
matrix: | ||
os: [macos-13, ubuntu-22.04] | ||
toolchain: ["stable", "nightly"] | ||
|
||
steps: | ||
- name: Install Rust | ||
uses: actions-rs/toolchain@v1 | ||
with: | ||
toolchain: ${{ matrix.toolchain }} | ||
override: true | ||
|
||
- name: checkout code | ||
uses: actions/checkout@v1 | ||
|
||
- name: test | ||
run: make test |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
[package] | ||
name = "tailchat" | ||
version = "0.1.0" | ||
edition = "2021" | ||
|
||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html | ||
|
||
[dependencies] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
.PHONY: test | ||
test: | ||
cargo test | ||
|
||
.PHONY: lint | ||
lint: | ||
cargo fmt --check | ||
cargo clippy | ||
|
||
.PHONY: lint/fix | ||
lint/fix: | ||
cargo clippy --fix | ||
|
||
.PHONY: fmt | ||
fmt: | ||
cargo fmt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,50 @@ | ||
# tailchat | ||
tailchat is a minimal/non scalable/crazy/possibly fun take on p2p chatting | ||
|
||
tailchat is a minimal/non scalable/crazy/possibly fun take on p2p chatting. | ||
|
||
This is an experiment mostly for fun and to explore the possibilities when you | ||
have a secure small network and want to chat with people inside it. | ||
|
||
Not a novel idea... We know... but we also want to play around with some Rust :-). | ||
|
||
The major architectural constraints are: | ||
|
||
1. Communication is always peer to peer | ||
2. Any storage (if any) is stored only on the peers participating on the conversation | ||
3. The network is secure (protocols will be plain text/binary, no TLS) | ||
4. Peer to peer communication is always possible | ||
|
||
The constraints and the overall design are inspired on the ideas by [Remembering the LAN](https://crawshaw.io/blog/remembering-the-lan), | ||
a time where building networked software was easy and simple (we are that old): | ||
|
||
``` | ||
The LAN was a magical place to learn about computers. | ||
Besides the physical aspect of assembling and disassembling machines, | ||
I could safely do things unthinkable on the modern internet: permission-less file sharing, | ||
experimental servers with no security, shared software where any one machine could easily bring down | ||
the network by typing in an innocuous command. | ||
Even when I did bring down the network the impact never left the building. | ||
I knew who I had to apologise to. | ||
With our LAN easy things were easy, and some hard things were possible. | ||
``` | ||
|
||
Technology like wireguard/tailscale helps us go back to those simpler times by building "LANs" on top | ||
of the Internet. We want to explore building things on top of this model, where application code | ||
can just trust other peers and doesn't need to deal with the hassle of making peer-to-peer communication | ||
work (NAT traversal is solved by the network layer, or NAT is not an issue for you like in a LAN). | ||
|
||
In general the project should work fine in a mesh VPN like Tailscale, but would also work fine in an actual LAN. | ||
|
||
## Installing | ||
|
||
TODO | ||
|
||
## Basic usage | ||
|
||
TODO | ||
|
||
## User Discovery | ||
|
||
TODO | ||
At some point document different methods of user discovery ? For now start with adding IP/Hosts manually and all good :-). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
pub fn run() { | ||
println!("tailchat!!!"); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
fn main() { | ||
tailchat::run(); | ||
} |