Updated readme - added installation and usage instructions.

2021-04-14 12:59:47 +02:00
parent 37941103ba
commit 40a4af4cc1
1 changed files with 14 additions and 2 deletions
@@ -55,7 +55,10 @@ pacman -U alfis-<version>-1-x86_64.pkg.tar.xz

 ## Installation

-### Debian/Ubuntu
+### Debian/Ubuntu (only blockchain DNS, without GUI)
+If you want to just use ALFIS as a DNS daemon and resolve domains in blockchain, as well as clearnet domains.
+You just need to install `alfis` service from repo and change your resolver in `/etc/resolv.conf`.
+Beware of NetworkManager, it can change your resolvers at will.

 1. Download repository public key and add it to your APT
 ```
@@ -75,3 +78,12 @@ sudo apt install alfis
 ```
 After that configuration is in file `/etc/alfis.conf` and data is saved to `/var/lib/alfis`.
 If you have some DNS server bound to port 53, it will not properly start. Deal with it on your own.
+
+### GUI version Windows/Linux/MacOS (if you want to create and change domains)
+If you want to create and manage your own domains on blockchain, you will need a version with GUI.
+You can download it from [releases](https://github.com/Revertron/Alfis/releases) section, choose appropriate OS and architecture version.
+It needs to be without `nogui` suffix.
+
+Just unzip that archive in some directory and run `alfis` (or `alfis.exe`) binary.
+By default, it searches for config file, named `alfis.toml` in current working directory, and creates/changes `blockchain.db` file in the same directory.
+If you want it to load config from another file you can command it so: `alfis -c /etc/alfis.conf`.