README.md

yip

Tiniest server which responds with requester IPv4 address

• Why
• Usage
  • Cargo
  • Binary
  • Specify custom port
• Contributing
  • Where to start?
• Code of Conduct
• License

Why

⬆️ Back to Top

This server is the counter part to https://github.com/kevingimbel/mip.

It responds with the callers' IP address on request. That's it.

Usage

⬆️ Back to Top

Cargo

Run the server with cargo run, then connect to it on port 8111.

Binary

Build the binary for your system with cargo.

$ cargo build --release

Then copy the binary from target/release/yip to some place in your $PATH. Afterwards the server can be started by running yip.

$ yip

Specify custom port

By default port 8111 is used. A different port can be set with the environment variable PORT.

$ PORT=8080 yip

Contributing

⬆️ Back to Top

We love and welcome every form of contribution!

Where to start?

Here are some good places to start:

• Issues with label Good first issue
• Issues with label Documentation
• Providing example implementations or usage demos

See open issues.

Code of Conduct

⬆️ Back to Top

You are expected to follow our code of conduct when interacting with the project via issues, pull requests or in any other form. Many thanks to the awesome contributor covenant initiative!

License

⬆️ Back to Top

GNU AFFERO GENERAL PUBLIC LICENSE 3, see LICENSE file.