add project files

2019-08-24 15:19:48 +08:00
commit 74a2b3f89d
11 changed files with 2239 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,91 @@
+
+
+# updns
+
+[![Build Status](https://img.shields.io/travis/wyhaya/updns.svg?style=flat-square)](https://travis-ci.org/wyhaya/updns)
+[![Crates.io](https://img.shields.io/crates/v/updns.svg?style=flat-square)](https://crates.io/crates/updns)
+[![Crates.io](https://img.shields.io/crates/l/updns.svg?style=flat-square)](https://github.com/wyhaya/updns/blob/master/LICENSE)
+
+---
+
+updns is a simple DNS proxy server developed using `Rust`. You can intercept any domain name and return the ip you need.
+
+## Install
+
+[Download](https://github.com/wyhaya/updns/releases) the binary from the release page
+
+Or use `cargo` to install
+
+```bash
+cargo install updns
+```
+
+## Start to use
+
+```bash
+updns
+# or
+updns -c /your/hosts
+```
+
+You may use `sudo` to run this command because you will use the `53` port, make sure you have sufficient permissions.
+
+Now change your local DNS server to `127.0.0.1` 🚀
+
+### Command
+
+```
+Usage:
+    updns [COMMAND] [OPTION]
+            
+Command:
+    add        Add a DNS record
+    rm         Remove a DNS record
+    ls         Print all configured DNS records
+    config     Call vim to edit the configuration file
+    path       Print related directories
+    help       Print help information
+    version    Print version information
+
+Option:
+    -c    Specify a config file
+```
+
+## Running in docker
+
+Build docker image
+```bash
+docker build -t updns .
+```
+
+Start up
+```bash
+docker run -d --name updns -p 53:53/udp --restart always updns
+```
+
+## Config
+
+You can use `updns config` command and then call `vim` quick edit, or use `updns path` find the updns's installation directory and edit the `.updns` file
+
+You can specify standard domains, or utilize [regular expressions](https://rustexp.lpil.uk "rustexp") for dynamic matching, 
+You can update the config file at any time, updns will listen for file changes
+
+```ini
+bind     0.0.0.0:53    # Binding address
+proxy    8.8.8.8:53    # Proxy address
+
+# Domain matching
+google.com             1.1.1.1
+^(\w+.)?go+gle.com$    2.2.2.2
+
+# Import from other file
+import /other/hosts
+```
+
+## Reference
+
+[Building a DNS server in Rust](https://github.com/EmilHernvall/dnsguide)
+
+## License
+
+[MIT](./LICENSE) license