Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/averagehelper/ip-echo-cloudflare
A simple no-logs Cloudflare Worker that returns the caller's IP address. (Read-only Git mirror)
https://github.com/averagehelper/ip-echo-cloudflare
mirror
Last synced: 4 days ago
JSON representation
A simple no-logs Cloudflare Worker that returns the caller's IP address. (Read-only Git mirror)
- Host: GitHub
- URL: https://github.com/averagehelper/ip-echo-cloudflare
- Owner: AverageHelper
- License: gpl-3.0
- Created: 2023-03-11T23:08:29.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-16T23:24:17.000Z (about 1 year ago)
- Last Synced: 2024-11-24T19:39:40.981Z (about 1 month ago)
- Topics: mirror
- Language: TypeScript
- Homepage: https://git.average.name/AverageHelper/ip-echo-cloudflare
- Size: 947 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# IP Echo
A simple no-logs Cloudflare Worker that returns the caller's IP address.
## Usage
A `GET` request to will return a string containing the caller's IP address.
```sh
$ curl https://ip.average.name
1.2.3.4
```
The API is documented using [OpenAPI](https://petstore.swagger.io/?url=https://ip.average.name/openapi.yaml). You can generate a TypeScript client by plugging our spec file into [oazapfts](https://www.npmjs.com/package/oazapfts):
```sh
$ oazapfts https://ip.average.name/openapi.yaml ./ip.ts
```
```ts
import { ip } from "./ip";
const result = await ip();
switch (result.status) {
case 200:
console.info(result.data); // "1.2.3.4"
break;
case 404:
console.warn("Couldn't get IP address");
break;
default:
console.error("Something went very very wrong!");
}
```
## No logs?
Not actively. Cloudflare lets me start streaming live access logs down on-demand, and these logs tell me the IP address and inferred location of the request, which is far from ideal. You'll just have to trust that I'm not storing that anywhere.
If you're concerned I may be snooping, feel free to run your own instance:
### Prerequisites
This project uses [Nixpkg](https://nixos.org/download#download-nix) to manage the dev environment. Our `default.nix` file currently defines an environment that has appropriate versions of `curl`, `jq`, `node`, and `npm`. To make sure you have them available on your machine, try running the following commands:
```sh
$ nix-shell
$ npm -v && node -v
10.1.0
v20.9.0
```
Alternatively, you may install Node yourself by whatever method you prefer. This project requires [NodeJS](https://nodejs.org/) (version 20 or later) and [NPM](https://npmjs.org/).
### Clone the repo
```sh
$ cd path/to/parent
$ git clone https://git.average.name/AverageHelper/ip-echo-cloudflare.git
$ cd ip-echo-cloudflare
```
### Install dependencies
```sh
$ npm ci
```
### Make sure everything lints and compiles
```sh
$ npm run build
```
### Deploy to your own Cloudflare zone
```sh
$ npm run deploy
```