driptorch-controller/README.md

33 lines
1.7 KiB
Markdown
Raw Permalink Normal View History

2022-09-12 02:11:38 -04:00
# driptorch-controller
Controller for the Driptorch DNS + Proxy.
For more information, visit https://driptorch.net/
2022-09-14 01:46:35 -04:00
| [Code](https://git.sr.ht/~eviee/driptorch-controller) | [Issues](https://todo.sr.ht/~eviee/Driptorch) | [Development Mailing List](https://lists.sr.ht/~eviee/driptorch-devel) |
|-------------------------------------------------------|-----------------------------------------------|------------------------------------------------------------------------|
2022-09-12 02:11:38 -04:00
---
## Requirements:
2022-09-12 02:14:52 -04:00
#### Deployment
2022-09-12 02:11:38 -04:00
* PostgreSQL
2022-09-13 09:16:28 -04:00
* RabbitMQ
2022-09-12 02:11:38 -04:00
2022-09-12 02:14:52 -04:00
#### Development
2022-09-12 02:11:38 -04:00
* Rust 1.60+
* PostgreSQL
2022-09-13 09:16:28 -04:00
* RabbitMQ
2022-09-12 02:11:38 -04:00
## Environment Variables:
2022-09-13 09:16:28 -04:00
| **Variable** | **Description** | **Required?** |
|:------------:|:--------------------------------------------------------------------------------------------------------:|:-------------:|
| DATABASE_URL | PostgreSQL database connection URL | Y |
| AMQP_ADDR | Message queue (RabbitMQ) connection URL | Y |
| UAP_REGEXES | Path to the [BrowserScope UA regex YAML](https://github.com/ua-parser/uap-core/blob/master/regexes.yaml) | N |
2022-09-14 09:03:43 -04:00
| RSA_KEY | Path to the RSA private key used to create certificates !!! KEEP THIS SAFE | Y |
| XCC20_KEY | Path to the XChaCha20-Poly1305 key used to encrypt private keys !!! KEEP THIS SAFE | Y |
2022-09-12 02:11:38 -04:00
---
### See also
* [driptorch-client](https://git.sr.ht/~eviee/driptorch-client)
* [driptorch-panel](https://git.sr.ht/~eviee/driptorch-panel)