Browse Source

:tada: Initial commit

master
James Pond 4 months ago
commit
ad0b91f84d
Signed by: James Pond <root@madpony.co> GPG Key ID: 9B87178193803B8E

+ 35
- 0
.editorconfig View File

@@ -0,0 +1,35 @@
# This file is for unifying the coding style for different editors and IDEs
# editorconfig.org

root = true

# Default
[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

# CSS
# google.github.io/styleguide/htmlcssguide.xml#General_Formatting_Rules
[*.css]
indent_size = 2
indent_style = space
trim_trailing_whitespace = true

# HTML
# google.github.io/styleguide/htmlcssguide.xml#General_Formatting_Rules
[*.{htm,html}]
indent_size = 2
indent_style = space
trim_trailing_whitespace = true

# Shell
# google.github.io/styleguide/shell.xml#Indentation
[*.{bash,sh,zsh}]
indent_size = 2
indent_style = space

# Markdown
[*.md]
trim_trailing_whitespace = false

+ 40
- 0
.gitea/ISSUE_TEMPLATE.md View File

@@ -0,0 +1,40 @@
**Please answer the following questions before submitting an issue.**

- [ ] I am running the latest version
- [ ] I checked the documentation and found no answer
- [ ] I checked to make sure that this issue has not already been filed

**Description**
A clear and concise description of what the bug or feature request.

**What is this?**

- [ ] Bug Report
- [ ] Feature Request

**To Reproduce**
Steps to reproduce the behavior, if applicable:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information if applicable):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information if applicable):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.

+ 12
- 0
.gitea/PULL_REQUEST_TEMPLATE.md View File

@@ -0,0 +1,12 @@
<!--- Provide a general summary of your changes in the Title above. -->
<!--- Don't worry, these comments go away when you submit! -->

## What's does this do?
<!--- Does this reference any Issue #s ? If so, please link them. -->
<!--- Otherwise, please provide a summary of WHY and HOW this was done. -->
<!--- If needed, does this update the documentation? -->

## How has this been tested?
<!--- Does this break any functionality? -->

Detailed changes are in commits below.

BIN
.gitea/assets/but-why.gif View File


+ 12
- 0
.gitignore View File

@@ -0,0 +1,12 @@
# https://i.imgur.com/asYPAMN.jpg
.DS_Store

# Files that might appear in the root of a volume.
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent
.Trash-*

+ 4
- 0
CHANGELOG.md View File

@@ -0,0 +1,4 @@
# Changelog
All notable changes to this project will be documented in this file.

*The format of this changelog file is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).*

+ 76
- 0
CODE_OF_CONDUCT.md View File

@@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies within all project spaces, and it also applies when
an individual is representing the project or its community in public spaces.
Examples of representing a project or community include using an official
project e-mail address, posting via an official social media account, or acting
as an appointed representative at an online or offline event. Representation of
a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [help@madpony.co](mailto:help@madpony.co). All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq

+ 70
- 0
CONTRIBUTING.md View File

@@ -0,0 +1,70 @@
# Contributing to [PROJECT NAME]

Hey :wave:,

Thank you for taking the time to help us make this project better!

We're thrilled that you'd like to contribute and we'd love for you to get involved. Whatever your level of skill or however much time you can give, your contribution is greatly appreciated.

There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests, helping other users by commenting on issues, or writing code which can be incorporated into our project.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

## Looking for support?

We'd love to help. Check out [the support guidelines](SUPPORT.md).

## How to report a bug

Think you found a bug? Please check [the list of open issues](https://gitgit.dev/madponydotco/allonsip.sh/issues) to see if your bug has already been reported. If it hasn't, please [submit a new issue](https://gitgit.dev/madponydotco/allonsip.sh/issues/new).

Here are a few tips for writing *great* bug reports:

* Describe the specific problem, with screenshots if possible
* Include the steps to reproduce the bug, what you expected to happen, and what happened instead
* Check that you are using the latest version of the project and its dependencies
* Include what version of the project your using, as well as any relevant dependencies
* Only include one bug per issue. If you have discovered two bugs, please file two issues

**If you find a security vulnerability, do not open an issue. Please check our [security policy](SECURITY.md) for instructions.**

## How to suggest a feature or enhancement

If you find yourself wishing for a feature that doesn't exist in this project, you are probably not alone. There are bound to be others out there with similar needs.

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and goals of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible, including describing the problem you're trying to solve.

[Open an issue](https://gitgit.dev/madponydotco/allonsip.sh/issues/new) which describes the feature you would like to see, why you want it, how it should work, etc.

## Your first contribution

We'd love for you to contribute to the project. Unsure where to begin contributing? You can start by looking through these "good first issue" and "help wanted" issues:

* [Good first issues](https://gitgit.dev/madponydotco/allonsip.sh/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) - issues which should only require a few lines of code and a test or two
* [Help wanted issues](https://gitgit.dev/madponydotco/allonsip.sh/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) - issues which may be a bit more involved, but are specifically seeking community contributions

*PS: Feel free to ask for help!* :smiley_cat:

## How to propose changes

Here's a few general guidelines for proposing changes:

* If you are making visual changes, include a screenshot of what the affected element looks like, both before and after.
* Each pull request should implement **one** feature or bug fix. If you want to add or fix more than one thing, submit more than one pull request
* Do not commit changes to files that are irrelevant to your feature or bug fix
* Don't bump the version number in your pull request (it will be bumped prior to release)
* Write [a good commit message](https://www.conventionalcommits.org/en/)

At a high level, the process for proposing changes is:

1. [Fork](https://gitgit.dev/madponydotco/allonsip.sh/fork) and clone the project
4. Create a new branch: `git checkout -b my-branch-name`
5. Make your change
6. Push to your fork and [submit a pull request](https://gitgit.dev/madponydotco/allonsip.sh/compare)
7. Pat your self on the back and wait for your pull request to be reviewed and merged

**Interesting in submitting your first Pull Request?** It's easy! You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)

## Code of conduct

This project is governed by [the Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.

+ 319
- 0
LICENSE.md View File

@@ -0,0 +1,319 @@
GNU GENERAL PUBLIC LICENSE

Version 2, June 1991

Copyright (C) 1989, 1991 Free Software Foundation, Inc.

51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 , USA

Everyone is permitted to copy and distribute verbatim copies of this license
document, but changing it is not allowed.

Preamble

The licenses for most software are designed to take away your freedom to share
and change it. By contrast, the GNU General Public License is intended to
guarantee your freedom to share and change free software--to make sure the
software is free for all its users. This General Public License applies to
most of the Free Software Foundation's software and to any other program whose
authors commit to using it. (Some other Free Software Foundation software
is covered by the GNU Lesser General Public License instead.) You can apply
it to your programs, too.

When we speak of free software, we are referring to freedom, not price. Our
General Public Licenses are designed to make sure that you have the freedom
to distribute copies of free software (and charge for this service if you
wish), that you receive source code or can get it if you want it, that you
can change the software or use pieces of it in new free programs; and that
you know you can do these things.

To protect your rights, we need to make restrictions that forbid anyone to
deny you these rights or to ask you to surrender the rights. These restrictions
translate to certain responsibilities for you if you distribute copies of
the software, or if you modify it.

For example, if you distribute copies of such a program, whether gratis or
for a fee, you must give the recipients all the rights that you have. You
must make sure that they, too, receive or can get the source code. And you
must show them these terms so they know their rights.

We protect your rights with two steps: (1) copyright the software, and (2)
offer you this license which gives you legal permission to copy, distribute
and/or modify the software.

Also, for each author's protection and ours, we want to make certain that
everyone understands that there is no warranty for this free software. If
the software is modified by someone else and passed on, we want its recipients
to know that what they have is not the original, so that any problems introduced
by others will not reflect on the original authors' reputations.

Finally, any free program is threatened constantly by software patents. We
wish to avoid the danger that redistributors of a free program will individually
obtain patent licenses, in effect making the program proprietary. To prevent
this, we have made it clear that any patent must be licensed for everyone's
free use or not licensed at all.

The precise terms and conditions for copying, distribution and modification
follow.

TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

0. This License applies to any program or other work which contains a notice
placed by the copyright holder saying it may be distributed under the terms
of this General Public License. The "Program", below, refers to any such program
or work, and a "work based on the Program" means either the Program or any
derivative work under copyright law: that is to say, a work containing the
Program or a portion of it, either verbatim or with modifications and/or translated
into another language. (Hereinafter, translation is included without limitation
in the term "modification".) Each licensee is addressed as "you".

Activities other than copying, distribution and modification are not covered
by this License; they are outside its scope. The act of running the Program
is not restricted, and the output from the Program is covered only if its
contents constitute a work based on the Program (independent of having been
made by running the Program). Whether that is true depends on what the Program
does.

1. You may copy and distribute verbatim copies of the Program's source code
as you receive it, in any medium, provided that you conspicuously and appropriately
publish on each copy an appropriate copyright notice and disclaimer of warranty;
keep intact all the notices that refer to this License and to the absence
of any warranty; and give any other recipients of the Program a copy of this
License along with the Program.

You may charge a fee for the physical act of transferring a copy, and you
may at your option offer warranty protection in exchange for a fee.

2. You may modify your copy or copies of the Program or any portion of it,
thus forming a work based on the Program, and copy and distribute such modifications
or work under the terms of Section 1 above, provided that you also meet all
of these conditions:

a) You must cause the modified files to carry prominent notices stating that
you changed the files and the date of any change.

b) You must cause any work that you distribute or publish, that in whole or
in part contains or is derived from the Program or any part thereof, to be
licensed as a whole at no charge to all third parties under the terms of this
License.

c) If the modified program normally reads commands interactively when run,
you must cause it, when started running for such interactive use in the most
ordinary way, to print or display an announcement including an appropriate
copyright notice and a notice that there is no warranty (or else, saying that
you provide a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this License.
(Exception: if the Program itself is interactive but does not normally print
such an announcement, your work based on the Program is not required to print
an announcement.)

These requirements apply to the modified work as a whole. If identifiable
sections of that work are not derived from the Program, and can be reasonably
considered independent and separate works in themselves, then this License,
and its terms, do not apply to those sections when you distribute them as
separate works. But when you distribute the same sections as part of a whole
which is a work based on the Program, the distribution of the whole must be
on the terms of this License, whose permissions for other licensees extend
to the entire whole, and thus to each and every part regardless of who wrote
it.

Thus, it is not the intent of this section to claim rights or contest your
rights to work written entirely by you; rather, the intent is to exercise
the right to control the distribution of derivative or collective works based
on the Program.

In addition, mere aggregation of another work not based on the Program with
the Program (or with a work based on the Program) on a volume of a storage
or distribution medium does not bring the other work under the scope of this
License.

3. You may copy and distribute the Program (or a work based on it, under Section
2) in object code or executable form under the terms of Sections 1 and 2 above
provided that you also do one of the following:

a) Accompany it with the complete corresponding machine-readable source code,
which must be distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,

b) Accompany it with a written offer, valid for at least three years, to give
any third party, for a charge no more than your cost of physically performing
source distribution, a complete machine-readable copy of the corresponding
source code, to be distributed under the terms of Sections 1 and 2 above on
a medium customarily used for software interchange; or,

c) Accompany it with the information you received as to the offer to distribute
corresponding source code. (This alternative is allowed only for noncommercial
distribution and only if you received the program in object code or executable
form with such an offer, in accord with Subsection b above.)

The source code for a work means the preferred form of the work for making
modifications to it. For an executable work, complete source code means all
the source code for all modules it contains, plus any associated interface
definition files, plus the scripts used to control compilation and installation
of the executable. However, as a special exception, the source code distributed
need not include anything that is normally distributed (in either source or
binary form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component itself
accompanies the executable.

If distribution of executable or object code is made by offering access to
copy from a designated place, then offering equivalent access to copy the
source code from the same place counts as distribution of the source code,
even though third parties are not compelled to copy the source along with
the object code.

4. You may not copy, modify, sublicense, or distribute the Program except
as expressly provided under this License. Any attempt otherwise to copy, modify,
sublicense or distribute the Program is void, and will automatically terminate
your rights under this License. However, parties who have received copies,
or rights, from you under this License will not have their licenses terminated
so long as such parties remain in full compliance.

5. You are not required to accept this License, since you have not signed
it. However, nothing else grants you permission to modify or distribute the
Program or its derivative works. These actions are prohibited by law if you
do not accept this License. Therefore, by modifying or distributing the Program
(or any work based on the Program), you indicate your acceptance of this License
to do so, and all its terms and conditions for copying, distributing or modifying
the Program or works based on it.

6. Each time you redistribute the Program (or any work based on the Program),
the recipient automatically receives a license from the original licensor
to copy, distribute or modify the Program subject to these terms and conditions.
You may not impose any further restrictions on the recipients' exercise of
the rights granted herein. You are not responsible for enforcing compliance
by third parties to this License.

7. If, as a consequence of a court judgment or allegation of patent infringement
or for any other reason (not limited to patent issues), conditions are imposed
on you (whether by court order, agreement or otherwise) that contradict the
conditions of this License, they do not excuse you from the conditions of
this License. If you cannot distribute so as to satisfy simultaneously your
obligations under this License and any other pertinent obligations, then as
a consequence you may not distribute the Program at all. For example, if a
patent license would not permit royalty-free redistribution of the Program
by all those who receive copies directly or indirectly through you, then the
only way you could satisfy both it and this License would be to refrain entirely
from distribution of the Program.

If any portion of this section is held invalid or unenforceable under any
particular circumstance, the balance of the section is intended to apply and
the section as a whole is intended to apply in other circumstances.

It is not the purpose of this section to induce you to infringe any patents
or other property right claims or to contest validity of any such claims;
this section has the sole purpose of protecting the integrity of the free
software distribution system, which is implemented by public license practices.
Many people have made generous contributions to the wide range of software
distributed through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing to
distribute software through any other system and a licensee cannot impose
that choice.

This section is intended to make thoroughly clear what is believed to be a
consequence of the rest of this License.

8. If the distribution and/or use of the Program is restricted in certain
countries either by patents or by copyrighted interfaces, the original copyright
holder who places the Program under this License may add an explicit geographical
distribution limitation excluding those countries, so that distribution is
permitted only in or among countries not thus excluded. In such case, this
License incorporates the limitation as if written in the body of this License.

9. The Free Software Foundation may publish revised and/or new versions of
the General Public License from time to time. Such new versions will be similar
in spirit to the present version, but may differ in detail to address new
problems or concerns.

Each version is given a distinguishing version number. If the Program specifies
a version number of this License which applies to it and "any later version",
you have the option of following the terms and conditions either of that version
or of any later version published by the Free Software Foundation. If the
Program does not specify a version number of this License, you may choose
any version ever published by the Free Software Foundation.

10. If you wish to incorporate parts of the Program into other free programs
whose distribution conditions are different, write to the author to ask for
permission. For software which is copyrighted by the Free Software Foundation,
write to the Free Software Foundation; we sometimes make exceptions for this.
Our decision will be guided by the two goals of preserving the free status
of all derivatives of our free software and of promoting the sharing and reuse
of software generally.

NO WARRANTY

11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR
THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE
STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM
"AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE
OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME
THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE
OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA
OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES
OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH
HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS

How to Apply These Terms to Your New Programs

If you develop a new program, and you want it to be of the greatest possible
use to the public, the best way to achieve this is to make it free software
which everyone can redistribute and change under these terms.

To do so, attach the following notices to the program. It is safest to attach
them to the start of each source file to most effectively convey the exclusion
of warranty; and each file should have at least the "copyright" line and a
pointer to where the full notice is found.

<one line to give the program's name and an idea of what it does.>

Copyright (C) <yyyy> <name of author>

This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
Street, Fifth Floor, Boston, MA 02110-1301 , USA.

Also add information on how to contact you by electronic and paper mail.

If the program is interactive, make it output a short notice like this when
it starts in an interactive mode:

Gnomovision version 69, Copyright (C) year name of author Gnomovision comes
with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software,
and you are welcome to redistribute it under certain conditions; type `show
c' for details.

The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may be
called something other than `show w' and `show c'; they could even be mouse-clicks
or menu items--whatever suits your program.

You should also get your employer (if you work as a programmer) or your school,
if any, to sign a "copyright disclaimer" for the program, if necessary. Here
is a sample; alter the names:

Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision'
(which makes passes at compilers) written by James Hacker.

< signature of Ty Coon > , 1 April 1989 Ty Coon, President of Vice This General
Public License does not permit incorporating your program into proprietary
programs. If your program is a subroutine library, you may consider it more
useful to permit linking proprietary applications with the library. If this
is what you want to do, use the GNU Lesser General Public License instead
of this License.

+ 65
- 0
README.md View File

@@ -0,0 +1,65 @@
# :globe_with_meridians: Allons-ip!

> A simple public IP address API using nothing but NGINX.

![Uptime Robot ratio (30 days)](https://img.shields.io/uptimerobot/ratio/m782941548-0885f71ac85edda74d9f5999.svg) ![Maintenance](https://img.shields.io/maintenance/yes/2019.svg) ![Project License](https://img.shields.io/badge/license-GPL%20(%3E%3D%202)-blue.svg)

---

## About

**Allons-ip!** is a simple and completely free API service that anyone can use to get their public IP address. It uses nothing but NGINX to server requests, which makes it insane fast and reliable.

The API returns all data in plain text &mdash; or JSON &mdash;, without any advertisements or extra data. It runs on a dedicated AMD Ryzen™ Threadripper 2950X server in Germany, a country with has some of the best laws in the world to protect your right to privacy, has full disk encryption enabled and a no logging policy.

![But why?](https://cdn.gitgit.dev/madponydotco/allonsip.sh/raw/branch/master/.gitea/assets/but-why.gif)

**Why?** Because why not :man_shrugging:. We needed to get the public IP address of servers we deploy programmatically, and wanted to have control over how that was done, so **Allons-ip!** was born.

Since we did not want to reinvent the wheel and NGINX is so damn powerful, there was no need for anything other than pure NGINX.

## Usage

No secrets here, just call the URL for the API and it should return the IP address of the machine you used to make the call.

**Clear Text:**
`curl -s https://api.allonsip.sh/`

**JSON:**
`curl -s https://api.allonsip.sh/json/`

## FAQ

### What is up with the name?

It is a combination of me sucking at French and the usual love for [Doctor Who](https://en.wikipedia.org/wiki/Doctor_Who) that everyone in this company shares. Plus a dad level pun.

[Read more on this](https://tardis.fandom.com/wiki/Allons-y).

### Can I add checks against this API on my scripts?

My dear chap, absolutely! That is why we made this public in the first place, so others can use it.

### What about my privacy?

Nothing is ever logged, and there is no data to be sold here, period. Heck, we don't even have an easy way to check if this service is being used or not.

### Is the API reliable? Is it monitored?

Sure it is! We also promise that we're monitoring **Allons-ip!** 24 hours a day, 365 days a year. If there is a global service interruption, we're on it.

:point_right: [Check out our system status](https://status.madpony.network/).

## Bugs

See GitGit Issues: <https://gitgit.dev/madponydotco/allonsip.sh/issues>

## Author

- [@jamesponddotco](https://gitgit.dev/jamesponddotco)

## Acknowledgements

- [NGINX](https://nginx.org) - Simply the best web server there is
- [StudioPress](https://studiopress.com/) - Makers of the Genesis Framework, which is used as the base for our website
- [elementary OS](https://elementary.io/) - Color scheme and general awesomeness

+ 21
- 0
SECURITY.md View File

@@ -0,0 +1,21 @@
# Security Policy

Hey :wave:,

Being a privacy-oriented project, security is, obviously, quite important to us.

Thank you for taking the time to report security issues! We know you could be doing literally anything else right now, but you chose to help us improve this project instead, and that is priceless. Seriously, thank you.

Okay, now, to the formal part of this policy :weary:.

## Reporting a Vulnerability

If you found any kind of security issue in this project, please disclose the information responsibly by sending an email to [security@madpony.co](mailto:security@madpony.co) and not by creating an issue on this repository.

We recommend to use GPG for these kind of communications, the fingerprint for our key is `9694 9B96 8BB7 92BF 0B1F 0BF8 CDCC 8001 874B 6E9C`.

**You can run this command to download our key:**

```
gpg --keyserver keyserver.ubuntu.com --recv 96949B968BB792BF0B1F0BF8CDCC8001874B6E9C
```

+ 9
- 0
SUPPORT.md View File

@@ -0,0 +1,9 @@
# Support

> Unless stated otherwise, this project is provided as is and comes with no support.

However, it does not hurt to ask. Feel free to [send us an email at help@madpony.co](mailto:help@madpony.co), and we’ll try to get back to you between 11am and 9pm UTC, Monday to Friday. Don’t be shy — say hello!

## Bug reports

See the [contributing guidelines](CONTRIBUTING.md) for support related to bug reports.

+ 1
- 0
srv/allonsip.sh/www/assets/images/allonsip-logo.svg View File

@@ -0,0 +1 @@
<svg version="1.1" id="emoji" xmlns="http://www.w3.org/2000/svg" x="0" y="0" viewBox="0 0 72 72" xml:space="preserve"><style>.st1,.st2{fill:none;stroke:#0e141f;stroke-width:2;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10}.st2{stroke:#000}</style><circle cx="36" cy="36" r="28" fill="#8cd5ff" id="color"/><circle class="st1" cx="36" cy="36" r="28"/><path class="st1" d="M36 8v56c-8.6 0-15.5-12.5-15.5-28S27.4 8 36 8s15.5 12.5 15.5 28S44.6 64 36 64M64 36H8M60 22H12M60 50H12"/></svg>

Loading…
Cancel
Save