2018-11-22 15:40:59 +00:00
|
|
|
Hagrid
|
|
|
|
======
|
2018-08-16 18:35:19 +00:00
|
|
|
|
2019-06-15 17:49:59 +00:00
|
|
|
Hagrid is a verifying OpenPGP key server.
|
|
|
|
|
|
|
|
You can find general instructions and an API documentation at the running
|
2019-09-06 17:21:32 +00:00
|
|
|
instance at [https://keys.openpgp.org](https://keys.openpgp.org).
|
2018-09-19 20:27:25 +00:00
|
|
|
|
2019-05-03 09:10:34 +00:00
|
|
|
License
|
|
|
|
-------
|
|
|
|
|
|
|
|
Hagrid is free software: you can redistribute it and/or modify it
|
|
|
|
under the terms of the GNU Affero General Public License as published
|
|
|
|
by the Free Software Foundation, either version 3 of the License, or
|
|
|
|
(at your option) any later version.
|
|
|
|
|
|
|
|
Hagrid is distributed in the hope that it will be useful, but WITHOUT
|
|
|
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
|
|
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public
|
|
|
|
License for more details.
|
|
|
|
|
|
|
|
You should have received a copy of the GNU Affero General Public
|
|
|
|
License along with Hagrid. If not, see
|
|
|
|
<https://www.gnu.org/licenses/>.
|
|
|
|
|
2018-09-19 20:27:25 +00:00
|
|
|
Quick Start
|
|
|
|
-----------
|
|
|
|
|
2019-02-21 21:44:58 +00:00
|
|
|
Building Hagrid requires a working nightly Rust toolchain. The
|
2018-10-18 14:54:00 +00:00
|
|
|
easiest way to get the toolchain is to download [rustup](https://rustup.rs).
|
2019-06-15 17:49:59 +00:00
|
|
|
After rustup is installed, get the nightly compiler and tools, copy the
|
|
|
|
config file, and simply compile and run:
|
2018-10-18 14:54:00 +00:00
|
|
|
|
|
|
|
```bash
|
2019-02-12 13:09:06 +00:00
|
|
|
cd hagrid
|
|
|
|
rustup override set nightly
|
2019-06-15 17:49:59 +00:00
|
|
|
cp Rocket.toml.dist Rocket.toml
|
|
|
|
cargo run
|
2018-10-18 14:54:00 +00:00
|
|
|
```
|
|
|
|
|
2019-06-15 17:49:59 +00:00
|
|
|
This will spawn a web server listening on port 8080.
|
2018-10-18 14:54:00 +00:00
|
|
|
|
2019-06-15 17:49:59 +00:00
|
|
|
For deployment, a release build should be used (`cargo build --release`). This
|
|
|
|
will be statically built, and can be copied anywhere. You will also need to
|
|
|
|
adjust `Rocket.toml` accordingly. Hagrid uses `sendmail` for mailing, so you
|
|
|
|
also need a working local mailer setup.
|
2018-11-22 15:40:59 +00:00
|
|
|
|
2019-01-09 13:56:51 +00:00
|
|
|
Reverse Proxy
|
|
|
|
-------------
|
|
|
|
|
2019-02-28 15:57:03 +00:00
|
|
|
Hagrid is designed to defer lookups to reverse proxy server like Nginx
|
2019-06-15 17:49:59 +00:00
|
|
|
and Apache. Lookups via `/vks/v1/by-finingerprint`, `/vks/v1/by-keyid`, and
|
|
|
|
`/vks/v1/by-email` can be handled by a robust and performant HTTP server. A
|
|
|
|
sample configuration for nginx is part of the repository (`nginx.conf`,
|
|
|
|
`hagrid-routes.conf`).
|
2019-01-09 13:56:51 +00:00
|
|
|
|
2018-11-22 15:40:59 +00:00
|
|
|
Community
|
|
|
|
---------
|
|
|
|
|
2019-06-15 17:49:59 +00:00
|
|
|
We're in `#hagrid` on Freenode IRC, also reachable via Matrix as
|
|
|
|
`#hagrid:stratum0.org`.
|