aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWojciech Kosior <kwojtus@protonmail.com>2020-06-04 15:56:42 +0200
committerWojciech Kosior <kwojtus@protonmail.com>2020-06-04 15:56:42 +0200
commit5921557e322c0386ebc9a4ae00a9466c484eefb4 (patch)
tree8a3d0b033904039dbdfd4c6f701c011a6d4d11f6
parent95ba03e7ec7a8d52135e1e6f27b91520b1ea4302 (diff)
download0tdns-5921557e322c0386ebc9a4ae00a9466c484eefb4.tar.gz
0tdns-5921557e322c0386ebc9a4ae00a9466c484eefb4.zip
update readme
-rw-r--r--README.md41
1 files changed, 35 insertions, 6 deletions
diff --git a/README.md b/README.md
index a932e71..4684e50 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
# 0TDNS - Zero Trust DNS
-A way to control YOUR name resolution
+A way to control name resolution
First - get some openvpn config; http://vpngate.net seems like a good place to go
@@ -8,18 +8,47 @@ your system! Always look into the config before using it :)
Now let's say you want to run `ping fsf.org` through openvpn connection.
Let's say `conf.ovpn` is your openvpn config file.
-First, prepare your system (account creation and the like):
+First, install relevant scripts on your system
# ./install.sh
+You can also install to an arbitrary directory
+(0tdns won't run from there, however; this is just to make things easier for
+distro packagers or to install in a chroot)
+
+ # ./install.sh /path/to/installation/root
+
+The `install.sh` script above only copies some files to the filesystem.
+You also need some setup, which is done with
+
+ # ./setup.sh
+
+For now, the `setup.sh` script only creates a `0tdns` user in the system.
+Some other setup-related stuff might be added to it later.
+
+One might wonder why there isn't a single script to install files and
+create the user? The reason is, again, to make things easier for distros.
+Packager would install software to a directory and make a package from it
+(using appropriate tools, of course). They would use `setup.sh` to create
+a script, that is attached to the package and run at installation.
+
Now, execute:
- # ./vpn_wrapper.sh conf.ovpn ping devuan.org
+ # ./vpn_wrapper.sh conf.ovpn ping fsf.org
+
+the wrapper shall create an openvpn connection and a network namespace with
+all packets (except those to localhost) routed through the vpn. It then executes
+given command inside the namespace.
-Enjoy!
+For now - this is all that can be simply tried out. Other parts of the project
+work with database.
-If you don't want to be playing with 0tdns anymore - run:
+For other half (database creation and front-end) check https://github.com/kamsza/io_django
+
+You can remove te user with
# ./uninstall.sh
-All the heavy stuff is yet to be added ;)
+Or remove the user together with files by running
+
+ # ./uninstall.sh --delete-files