3 Commits

Author SHA1 Message Date
b7eda04c04 Added curl example to README. 2024-06-02 19:50:01 +03:00
3e7e66eb03 Merge pull request 'http-rewrite' (#1) from ryyst/traceroute_map:http-rewrite into master
Reviewed-on: MrKalzu/traceroute_map#1
2024-06-02 19:21:28 +03:00
c4244e86e6 TEMP 2024-06-02 00:22:00 +03:00

30
README.md Normal file
View File

@ -0,0 +1,30 @@
# Traceroute Internet Mapper - TIM
## Development
```sh
# Install all dependencies. `pipenv` was used previously:
pipenv --python 3.11
pipenv install
pipenv shell
# Start dev server
fastapi dev app/main.py
# Start posting data to the tracing endpoint:
traceroute git.rauhala.info -q1 | http POST localhost:8000/trace/MYHOSTNAME
or, with curl:
traceroute tuoppi.dy.fi -q1 | curl -X POST http://localhost:8000/trace/MYHOSTNAME --data-binary @-
```
## URLs of interest
- http://localhost:8000/
- API Index, nothing to see.
- http://localhost:8000/docs/
- Autogenerated API docs, mildy interesting
- http://localhost:8000/static/index.html
- Rendered HTML index, very interesting