dip/README.md

67 lines
2.1 KiB
Markdown
Raw Normal View History

2020-01-29 12:39:17 +01:00
# dip
2020-12-05 18:44:11 +01:00
[![Build Status](https://drone.paulbsd.com/api/badges/paulbsd/dip/status.svg)](https://drone.paulbsd.com/paulbsd/dip)
2019-12-22 18:20:45 +01:00
dip is a small webservice designed to return public ip address
## Howto
2020-01-29 12:30:41 +01:00
### Prerequisites
2019-12-22 18:20:45 +01:00
2020-01-27 21:16:08 +01:00
Install packr to create embedded files in binary executable file
2020-01-26 16:38:57 +01:00
```bash
2020-01-27 21:16:08 +01:00
go get -u github.com/gobuffalo/packr/v2/packr2
2020-01-26 16:38:57 +01:00
```
2020-01-27 21:16:08 +01:00
### Build
2019-12-22 18:20:45 +01:00
```bash
2020-01-27 21:16:08 +01:00
make
2019-12-22 18:20:45 +01:00
```
### Play
2020-01-26 16:38:57 +01:00
Query webservice with json output
2020-02-07 07:01:29 +01:00
```bash
curl http://localhost:8080/
2020-02-07 07:01:29 +01:00
```
2020-01-26 16:38:57 +01:00
Query webservice with html output
2020-02-07 07:01:29 +01:00
```bash
2020-01-26 16:38:57 +01:00
curl -H "Accept: text/html" http://localhost:8080/
2020-02-07 07:01:29 +01:00
```
## Todo
- Add tests
2019-12-22 18:20:45 +01:00
## License
```text
2020-01-27 21:16:08 +01:00
Copyright (c) 2020 PaulBSD
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
2020-01-29 12:30:41 +01:00
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
The views and conclusions contained in the software and documentation are those
of the authors and should not be interpreted as representing official policies,
2020-03-06 14:48:39 +01:00
either expressed or implied, of this project.
2020-01-26 16:38:57 +01:00
```