Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pnedkov authored Jan 14, 2024
1 parent 258b2b3 commit 21db0a9
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,13 @@ Another ifconfig-like web application. This one is written in Python with Flask
<a href="https://ipask.me"><kbd>ipask.me</kbd></a>

---
<details>
<summary>

## Getting started

</summary>

* Install Python:
```
pacman -S python
Expand Down Expand Up @@ -53,9 +58,16 @@ Another ifconfig-like web application. This one is written in Python with Flask
Or you could use your own key and certificate. `docker-compose.yaml` expects to find them here:
- $HOME/.nginx/key.pem
- $HOME/.nginx/cert.pem
</details>

---
## Run from the source code:
<details>
<summary>

## Run from the source code

</summary>


* Run using `run.sh`:
```sh
Expand Down Expand Up @@ -97,10 +109,16 @@ Another ifconfig-like web application. This one is written in Python with Flask
sudo usermod -aG docker $USER
sudo systemctl enable -now docker.service
```
</details>

---
<details>
<summary>

## Run in a stand-alone container

</summary>

* Build:
```sh
docker build -t ipask .
Expand All @@ -117,10 +135,16 @@ Another ifconfig-like web application. This one is written in Python with Flask
wget -qO - <host>:8080[/ip|/host|/xff|/ua|/headers|/city|/country]
```
Or navigate to `http://<host>:8080` from your browser.
</details>

---
<details>
<summary>

## Run with Docker Compose behind nginx reverse proxy

</summary>

* Run:

Two options: Build the container or pull the latest published container version from hub.docker.com
Expand All @@ -142,3 +166,4 @@ Another ifconfig-like web application. This one is written in Python with Flask
wget --no-check-certificate -qO - <host>[/ip|/host|/xff|/ua|/headers|/city|/country]
```
Or navigate to `<host>` from your browser. It will automatically redirect to https and you have to accept the self-signed certificate.
</details>

0 comments on commit 21db0a9

Please sign in to comment.