Files
Alfis/README.md
T

55 lines
2.1 KiB
Markdown
Raw Normal View History

2021-02-16 18:06:46 +01:00
# Alfis
2021-02-22 23:46:37 +01:00
2021-02-23 16:34:18 +01:00
![Builds](https://github.com/Revertron/Alfis/actions/workflows/rust_build_and_test.yml/badge.svg)
2021-02-16 18:06:46 +01:00
Alternative Free Identity System
2021-03-31 14:03:20 +02:00
This project represents a minimal blockchain without cryptocurrency, capable of sustaining any number of domain name zones and domains.
2021-02-16 23:27:25 +01:00
2021-03-31 14:03:20 +02:00
![Screenshot](img/keys.png)
2021-03-31 14:03:20 +02:00
![Screenshot](img/domains.png)
2021-02-25 16:13:33 +01:00
2021-02-16 23:27:25 +01:00
2021-03-19 16:36:13 +01:00
## Building and running
2021-02-16 23:27:25 +01:00
### On every OS
2021-03-19 16:36:13 +01:00
You can download and run already built binaries from [releases](https://github.com/Revertron/Alfis/releases), or you can build project yourself.
2021-02-16 23:27:25 +01:00
You can build Alfis by issuing `cargo build` and `cargo run` commands in a directory of cloned repository.
If you want to build release version you need to do `cargo build --release` as usual.
2021-04-04 11:04:01 +05:00
### ![Windows Logo](/img/windows.svg) On Windows
2021-02-16 23:27:25 +01:00
You don't need any additional steps to build Alfis, just stick to the MSVC version of Rust.
2021-03-19 16:36:13 +01:00
If you see an error about missing `VCRUNTIME140.dll` when running alfis you will need to install [VC Redistributable](https://www.microsoft.com/en-us/download/details.aspx?id=52685) from Microsoft.
If you want to use modern browser engine from Edge instead of old from IE, you need to build with this command: `cargo build --release --features "edge"` (or use corresponding build from [releases](https://github.com/Revertron/Alfis/releases)).
2021-04-04 11:04:01 +05:00
### ![Windows Logo](/img/windows.svg) On Windows (MINGW64)
2021-02-16 23:27:25 +01:00
If you'd rather use Gnu version of Rust you can build Alfis by these steps:
```
2021-02-22 23:46:37 +01:00
pacman -S git mingw64/mingw-w64-x86_64-rust mingw64/mingw-w64-x86_64-cargo-c
2021-02-16 23:27:25 +01:00
git clone https://github.com/Revertron/Alfis.git
cd Alfis
cargo build
```
2021-04-04 11:04:01 +05:00
### ![Linux Logo](/img/linux.svg) On Linux
2021-02-16 23:27:25 +01:00
If you are building on Linux you must ensure that you have `libwebkitgtk` library installed.
2021-02-23 16:34:18 +01:00
You can do it by issuing this command: `sudo apt install libwebkit2gtk-4.0-dev` (on Debian/Ubuntu and derivatives).
2021-04-03 17:44:49 +05:00
2021-04-04 11:04:01 +05:00
#### ![Arch Linux Logo](/img/archlinux.svg) On Arch Linux
2021-04-03 17:44:49 +05:00
Create and install package with this commands:
```sh
# make package
git clone https://github.com/Revertron/Alfis.git
cd Alfis/contrib
2021-04-03 17:44:49 +05:00
makepkg
# install package (from root)
pacman -U alfis-<version>-1-x86_64.pkg.tar.xz
2021-04-03 17:44:49 +05:00
```