diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..3241805 --- /dev/null +++ b/readme.md @@ -0,0 +1,57 @@ +# IPHistory + +The IPHistory project is a simple yet effective solution for tracking and logging the public IP address of your machine. It periodically fetches the public IP address and logs it to a file, while also providing a web interface to view the IP history in a clean UI and an endpoint (`/history`) for JSON format. + +## Running Locally + +### With Docker + +```sh +git clone https://github.com/yourusername/iphistory +cd iphistory +docker build -t iphistory:main . +docker run -p 8080:8080 iphistory:main +``` + +### Without Docker + +```sh +git clone https://github.com/yourusername/iphistory +cd iphistory +go run main.go +``` + +## Deploying + +### Docker Compose + +```yaml +version: '3.9' +services: + iphistory: + container_name: iphistory + image: 'ghcr.io/skidoodle/iphistory:main' + restart: unless-stopped + ports: + - '8080:8080' + volumes: + - data:/app +volumes: + data: + driver: local +``` + +### Docker Run + +```sh +docker run \ + -d \ + --name=iphistory \ + --restart=unless-stopped \ + -p 8080:8080 \ + ghcr.io/skidoodle/iphistory:main +``` + +## License + +[MIT](https://github.com/skidoodle/iphistory/blob/main/license)