mauvehed / yourip

A simple web site to return yourIP

Report a Bug - Request a Feature - Suggest Improvement -

About

yourIP started as a simple web app to fulfill a common need I have of identifying my public IP without having to use other methods to relay it back to me. This is half a purposeful tool and the other half a nice excuse to learn some new things and deployment technologies.

Built With

• 
• 
• 

Usage

Development

Please see Contributing for how to setup a dev environment

Using the website

The current deployment of this tool is hosted and available to all online. You will have a couple choices for how you access the website and what format your ask for the IP address to be returned in.

1. Point your browser to the official app URL at https://yourip.app

2. Use your favorite command line web tool (e.g. curl, wget) to access one of the two endpoints (raw or json)

   $ curl -L yourIP.app/json
   {
     "ip": "123.45.6.78"
   }

   $ curl -L yourIP.app/raw
   123.45.6.78

Issues and feature requests

You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? You can help us by submitting an issue on GitHub. Before you create an issue, make sure to search the issue archive -- your issue may have already been addressed!

Please try to create bug reports that are:

• Reproducible. Include steps to reproduce the problem.
• Specific. Include as much detail as possible: which version, what environment, etc.
• Unique. Do not duplicate existing opened issues.
• Scoped to a Single Bug. One bug per report.

Even better: Submit a pull request with a fix or new feature!

Contributing

First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

Please read our contribution guidelines, and thank you for being involved!

Security

• yourIP follows good practices of security, but 100% security cannot be assured.
• yourIP is provided "as is" without any warranty. Use at your own risk.

For more information and to report security issues, please refer to our security documentation.

License

This project is licensed under the MIT license.

See LICENSE for more information.

Acknowledgements

Long desired to build, but for sure inspired by Zate's https://urip.fyi web project in Go

yourip's Issues

security: Sanitize before returning user data

Add endpoint for RAW output (IP only)

Add a new endpoint (/raw) which returns an HTML page with only the user's IP. This can be easily utilized for shell scripting and similar methods.

testing: Add pytest testing to project and CI

Add pytests for CI

Add pyproject.toml

Add pyproject.toml

Attach domain

Attach a vanity domain to this app for easy reference (bonus for TLS/HSTS)

Add endpoint for JSON output

Add a new endpoint (/json) which returns a JSON blob with only the user's IP. This can be easily utilized for shell scripting and similar methods.

Fix permissions for GITHUB_TOKEN

enhance: Add real IP check before return

feat: ipv6/v4 toggle to show either IP if present

What about ipv6 support and a way to output both ips and a toggle to show ipv4 or ipv6? Websites like https://www.wieistmeineip.de/ are able to show both. Would be helpful!

Add additional workflows from mauvehed/github-template-example