From 4e1184afaa02d076b6523bb1df5de8f698ef78af Mon Sep 17 00:00:00 2001 From: Foster Hangdaan Date: Sun, 18 Aug 2024 14:01:01 -0400 Subject: [PATCH] docs: Remove references to live API instance The live API instance will be shutting down. --- README.org | 40 +++++++++++++++------------------------- 1 file changed, 15 insertions(+), 25 deletions(-) diff --git a/README.org b/README.org index a09405b..a6a9084 100644 --- a/README.org +++ b/README.org @@ -4,31 +4,6 @@ A self-hosted API for obtaining your public IP address. -* Live API Usage - -An implementation of the API is available at [[https://ipme.fosterhangdaan.com][ipme.fosterhangdaan.com]]. - -| URL | Response Type | Sample Output | -|-------------------------------------------------------------+---------------+-------------------------------------| -| https://ipme.fosterhangdaan.com | text | =98.207.254.136= | -| https://ipme.fosterhangdaan.com?format=json | json | ={"ip":"98.207.254.136"}= | -| https://ipme.fosterhangdaan.com?format=jsonp | jsonp | =callback({"ip":"98.207.254.136"})= | -| https://ipme.fosterhangdaan.com?format=jsonp&callback=getIp | jsonp | =getIp({"ip":"98.207.254.136"})= | - -** Examples using ~curl~ - -To get your public IP address in plain text: - -#+begin_src shell -curl --silent https://ipme.fosterhangdaan.com -#+end_src - -For a response in =json= format: - -#+begin_src shell -curl --silent https://ipme.fosterhangdaan.com?format=json -#+end_src - * Self-hosting ** Requirements @@ -100,6 +75,21 @@ Run ~podman-compose up~ to start the services. The API should be available at the domain you selected. For example: =https://ipme.mydomain.com=. +** Examples using ~curl~ + +To get your public IP address in plain text: + +#+begin_src shell +curl --silent https://ipme.mydomain.com +#+end_src + +For a response in =json= format: + +#+begin_src shell +curl --silent https://ipme.mydomain.com?format=json +#+end_src + + * Contributing Please send patches and bug reports by email to one of the maintainers. See the *Core maintainers* section for a list of contacts.