Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/20tab/uwsgi-local-dns-resolver
https://github.com/20tab/uwsgi-local-dns-resolver
Last synced: 21 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/20tab/uwsgi-local-dns-resolver
- Owner: 20tab
- License: mit
- Created: 2015-04-19T18:52:04.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-01-13T08:09:48.000Z (almost 3 years ago)
- Last Synced: 2024-11-20T15:42:27.769Z (about 1 month ago)
- Language: Python
- Size: 23.4 KB
- Stars: 2
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# uWSGI-local-DNS-resolver
uWSGI-local-DNS-resolver (from now on __uWSGI-DNS__) is a DNS server that resolves to `localhost` each request directed to a uWSGI-subscribed domain.
# Why?
Our main intent is to let users transparently connect to their local development instances handled through a uWSGI HTTP subscription server.
## Project status
uWSGI-DNS is still a work in progress. As a consequence, its APIs could be subject to changes.
## Features
- Python 2 & Python 3 compatibility.
- UNIX/Linux systems compatibility.
- Automatic domain refresh on new uWSGI subscriptions.
- Failed nodes detection and handling.
## Installation
You can install uwsgi-dns through PIP with:
```bash
$ pip install uwsgidns # you could need to use sudo here, or -U
```
Alternatively, you can clone the repository manually:
```bash
$ git clone https://github.com/20tab/uwsgi-local-dns-resolver.git
$ cd uwsgi-local-dns-resolver
$ python setup.py install # you could need sudo here
```
And if you want, you can test the server with:
```bash
$ sudo uwsgidns # we need sudo to bind on reserved port 53
```
Once started, you should have a DNS server running on `localhost:53`.
Note: installing uWSGI-DNS inside a virtualenv is obviously possible, but you should use particular care while integrating it into uWSGI configuration files.
## Configuration
```bash
$ uwsgidns -h
usage: uwsgidns [-h] [-l {CRITICAL,ERROR,WARNING,INFO,DEBUG,NOTSET}] [-p]
[-u upstream DNS server URI] [-s uwsgi-HTTP-stats-URI]
DNS server that resolves to localhost uWSGI HTTP subscribed domains.
optional arguments:
-h, --help show this help message and exit
-l {CRITICAL,ERROR,WARNING,INFO,DEBUG,NOTSET}, --logging {CRITICAL,ERROR,WARNING,INFO,DEBUG,NOTSET}
set the logging level
-p, --proxy proxy other requests to upstream DNS server
(--upstream)
-u upstream DNS server URI, --upstream upstream DNS server URI
the URI to the upstream DNS server (with --proxy),
defaults to 8.8.8.8:53
-s uwsgi-HTTP-stats-URI, --stats uwsgi-HTTP-stats-URI
the URI (remote:port) to the uWSGI HTTP subscription
stats server
```
### Non-local requests
uWSGI-DNS can act as a DNS proxy (`-p`), forwarding each non-local request to the upstream server specified with the `-u` flag;
otherwise, it simply drops such requests and let the OS fallback DNS server handle them.
### uWSGI stats
Setting the `-s` will let uWSGI-DNS poll the uWSGI subscription server periodically.
In this way uWSGI-DNS will notice failed/disappeared HTTP nodes and will remove them from the local domains.
## uWSGI (Emperor) integration
The integration with the uWSGI emperor is simple and straightforward.
We assume you use the uWSGI HTTP subscription server.
To integrate uWSGI-DNS you can edit the configuration file of your emperor/subscription server as follows:
```ini
; uWSGI subscription server - ini configuration file
http = :80
http-subscription-server = 127.0.0.1:5005
http-stats-server = 127.0.0.1:5004
; resubscribe let uWSGI-DNS know about new HTTP nodes
http-resubscribe = 127.0.0.1:9696
; launch the uWSGI-DNS with the HTTP subscription server
; you can tweak the command line arguments and the path here
attach-daemon = uwsgidns
```
Anytime you'll launch the subscription system, the uWSGI-DNS server will launch with it.
Please note that in the following section we provide some more OS-specific examples.
## OS integration
TODO: other OSs integration.
The OS integration largely varies with each platforms.
We provide here just a few examples, adapt them to your needs.
### OS X integration
You can use LaunchD to automatically launch a uWSGI emperor instance on startup.
To do so, create the file `it.unbit.uwsgi.emperor.plist` in the `/Library/LaunchDaemons/` directory and make sure it has the following content.
The same example can also be found in this repository.
```plist
RunAtLoad
Disabled
KeepAlive
SuccessfulExit
Label
it.unbit.uwsgi.emperor
ProgramArguments
/usr/local/bin/uwsgi
--master
--die-on-term
--plugin
syslog
--logger
syslog:
--emperor
/Users/*/*/vassals/*.ini
--emperor
/Users/*/vassals/*.ini
--emperor-tyrant
--http
:80
--http-subscription-server
127.0.0.1:5005
--http-resubscribe
127.0.0.1:9696
--http-stats-server
127.0.0.1:5004
--emperor-stats-server
127.0.0.1:5000
--attach-daemon
/usr/local/bin/uwsgidns -p
```
Put the vassals configuration files in your home folder and then start the uWSGI emperor with the command:
```bash
$ sudo launchctl load /Library/LaunchDaemons/it.unbit.uwsgi.emperor.plist
```
You can finally edit your connection parameters and set the [custom DNS server](https://support.apple.com/kb/PH14159) pointing to `127.0.0.1`.
The DNS resolver will try to solve local requests and then will proxy to upstream the others.
The default upstream is `8.8.8.8:53` and you can customize it with the `-u UPSTREAM_ADDRESS:PORT` flag.
_Bonus_: before editing your network settings, you can create a new [Network Location](https://support.apple.com/en-us/HT202480) to be specifically used while developing and edit its DNS settings.
## Tests
TODO: add tests.