foster/ipme
1
0
Fork 0
Code Issues Pull requests Releases Packages 1 Activity

docs: Remove references to live API instance

Browse source 
The live API instance will be shutting down.
This commit is contained in:
Foster Hangdaan 2024-08-18 14:01:01 -04:00
parent 21c7a360c1
commit 4e1184afaa
Signed by: foster
GPG key ID: E48D7F49A852F112
1 changed files with 15 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
README.org
View file

@ -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.