domani/README.md
Brian Picciano 7db28b3793 readme
2023-05-15 21:46:40 +02:00

31 lines
786 B
Markdown

# Domiply
Domiply is a self-hosted rust service which connects a DNS hostname to a data
backend (e.g. a git repository), all with no account needed. The user only
inputs their domain name, their desired backend, and then adds two entries to
their DNS server.
[Demo which may or may not be live](https://domiply.mediocregopher.com)
## Development
Domiply uses nix flakes for building and setting up the development environment.
In order to open a shell with all necessary tooling (expected rust toolchain
versions, etc...) simply do:
```
nix develop
```
Within the shell which opens you can do `cargo run` to start a local instance.
In order to create a release binary:
```
nix build
```
## Roadmap
Check out the `src/service/http_tpl/index.html` file for the current roadmap.