myip.coffee/README.md
Kumi 81ac90c68e
feat: Launch MyIP.Coffee web service
Introduced a new web service, MyIP.Coffee, for displaying client IP addresses. This update includes:
- MIT License addition for open-source usage.
- README for setup instructions and project overview.
- PHP script and nginx configs to support IP address retrieval.
- Basic website structure with HTML, CSS, and JavaScript to display IPv4 and IPv6 addresses on load.

This service aims to provide a user-friendly platform for clients to easily find their public IP addresses, supporting both IPv4 and IPv6 with a focus on simplicity and efficiency. Future improvements may include enhanced IP detection and custom user settings.
2024-04-12 19:52:23 +02:00

34 lines
1.1 KiB
Markdown

# MyIP.Coffee
MyIP.Coffee is a simple web service that returns the IP address of the client making the request.
## Setup
There are two components to this project, the website and the endpoint that returns the IP address.
The endpoint runs on https://ipv4.myip.coffee and https://ipv6.myip.coffee. The IPv4 endpoint only has an A record, while the IPv6 endpoint has both only an AAAA record.
### nginx
If you use nginx, you don't need the endpoint. You can use the following configuration to return the IP address of the client:
```nginx
server {
listen 80;
listen [::]:80;
server_name ipv4.myip.coffee ipv6.myip.coffee;
location / {
return 200 "$remote_addr";
}
}
```
### PHP
As our web hosting solution comes with PHP, there is a PHP script in [endpoint/index.php](endpoint/index.php) that just returns the IP address of the client. It is trivial to implement this in other languages, so this is left as an exercise to the reader.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.