diff options
| author | B. Stack <bgstack15@gmail.com> | 2022-11-29 16:09:22 -0500 |
|---|---|---|
| committer | B. Stack <bgstack15@gmail.com> | 2022-11-29 16:09:22 -0500 |
| commit | 4a8ce7e2862b338a7f8e34d016a3119290239b0b (patch) | |
| tree | 951ad8a52ddf31e489e4fab7c0d0c96947d6b0f4 /README.md | |
| download | outbound-master.tar.gz outbound-master.tar.bz2 outbound-master.zip | |
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..ed5ccc5 --- /dev/null +++ b/README.md @@ -0,0 +1,72 @@ +<!-- + .. File: README.md + .. Location: https://bgstack15.ddns.net/cgit/outbound/ + .. Author: bgstack15 + .. SPDX-License-Identifier: GPL-3.0 + .. Startdate: 2022-11-28 + .. Title: Readme for Outbound project + .. Project: outbound + .. Purpose: Describe the project + .. History: + .. Usage: + .. Reference: See References heading + .. Improvements: + .. Documentation: this file + .. Dependencies: + --> +# README for outbound +This project is a small Flask app that merely redirects to the link farther down the URL. The purpose is to enable my web server to record visits to outbound links. This is not a URL shortener or obfuscator. It's a cheap way for me to see what links my site vistors use, without using javascript. + +## Upstream +The original project is at <https://bgstack15.ddns.net/cgit/outbound/>. + +## Features/design goals + +* redirect only if referer is in whitelist +* simple web config +* simple app config +* send to web server logs the redirects, or else 404s for invalid link requests + +## Alternatives +Probably some "proper" web analytics suite or javascript garbage that I do not want to learn or use. + +## Reason for existence +To show what links on my site are used. + +## Using + +### Web app +Run a simple dev environment. + + FLASK_APP=outbound.py FLASK_DEBUG=True flask run --host=0.0.0.0 --extra-files outbound.conf + +### Testing the web app with curl + + $ curl --header "Referer: http://d2-03a:5000/" --header 'Debug: true' http://d2-03a:5000/http://server3/ + <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> + <title>Redirecting...</title> + <h1>Redirecting...</h1> + <p>You should be redirected automatically to target URL: <a href="http://server3/">http://server3/</a>. If not click the link. + +## Improvements + +* Provide an apache wsgi config? +* Provide an nginx wsgi config? + +## Dependencies +For the web app: + +* apache with `mod_wsgi` +* python3-flask + +## References + +1. [fuss.conf.example](https://bgstack15.ddns.net/cgit/fuss/tree/fuss.conf.example) +2. [fuss.py](https://bgstack15.ddns.net/cgit/fuss/tree/fuss.py) +3. [coupons_web.py](https://bgstack15.ddns.net/cgit/coupons/tree/coupons_web.py) +4. <https://werkzeug.palletsprojects.com/en/2.2.x/serving/#werkzeug.serving.run_simple> +5. various [fifconfig](https://bgstack15.ddns.net/cgit/fifconfig/tree/) files + +### Internal documents + +1. ports.txt: outbound 4682/tcp |