Browse Source

Add setup documentation

master
Garrit Franke 4 years ago
parent
commit
89e861e5c1
  1. 23
      README.md

23
README.md

@ -7,6 +7,29 @@ cargo build --release
cp target/release/taurus /usr/bin/taurus
```
## Usage
By default, taurus looks for a configuration file at `/etc/taurus/taurus.toml`. Fields that can be configured are defined in `src/config.rs`.
An example config might look like this:
```toml
# Default gemini port is 1965
port = 1965
# Your TLS certificate
certificate_file= "identity.pfx"
# Must match with the password of the generated certificate
certificate_password = "mysecretpassword"
# Your gemini files
static_root = "/var/www/gemini"
```
You will need a TLS certificate in order to use taurus. To generate one, take a look at the section below.
## Generating a test-certificate
At the current state of the project, you need to generate a server certificate by hand. Take a look at `contrib/generate_cert.sh`, and run it.

Loading…
Cancel
Save