Start README
This commit is contained in:
parent
6f0b2b1cc5
commit
58a3f07960
1 changed files with 36 additions and 1 deletions
37
README.md
37
README.md
|
@ -1 +1,36 @@
|
||||||
# Contact form
|
# Oxiform
|
||||||
|
|
||||||
|
Oxiform is a self-hosted contact form for your website.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- Minimalistic but cutomizable with a YAML configuration file 🛠️
|
||||||
|
- Sends submitted forms per email 📨
|
||||||
|
- Captcha for protection against bots 🤖
|
||||||
|
- Responsive 📱
|
||||||
|
- Self-hosted. No privacy conserns 🔒️
|
||||||
|
- Low memory usage (about 8 MB) 🏅
|
||||||
|
- First class container support 📦️
|
||||||
|
- Informative tracing (loggin) to stdout and to a log file 📜
|
||||||
|
- Free & open source 🆓
|
||||||
|
- Written in Rust (**oxi**dized) 🦀
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
### Socket
|
||||||
|
|
||||||
|
| Parameter | Description | Default |
|
||||||
|
| -------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
|
||||||
|
| socket_address | Use `127.0.0.1:8080` for testing on `http://localhost:8080`. `0.0.0.0` is important for usage in a container, but you can pick another port. | 0.0.0.0:80 |
|
||||||
|
|
||||||
|
### Email
|
||||||
|
|
||||||
|
### Timezone
|
||||||
|
|
||||||
|
### Localization
|
||||||
|
|
||||||
|
## Roadmap
|
||||||
|
|
||||||
|
- At the moment, only text and textarea (multiple rows) fields are supported because I did not need more. But I would love to implement more types (Checkbox etc.) if you need any. Just open an issue!
|
||||||
|
- I would like to integrate [ntfy](https://github.com/dschep/ntfy) for notifications other than emails.
|
||||||
|
- You tell me. I am open for suggestions =D
|
||||||
|
|
Loading…
Reference in a new issue