2022-08-02 14:11:17 +05:30
# Segfautils
2022-07-28 14:50:41 +05:30
Web utilities for Project Segfault
## What does it do?
For now it powers our contact form. In the future we will expand our APIs so you can do more cool things.
## Setup
2022-08-01 02:19:08 +05:30
### Docker:
2022-07-28 14:50:41 +05:30
```
2022-08-15 00:52:08 +05:30
docker run -d --restart=always -p 6893:6893 --name segfautils -v "$(pwd)"/data:/segfautils/data projectsegfault/segfautils:latest
2022-07-28 14:50:41 +05:30
```
2022-08-15 00:52:08 +05:30
You need to copy the ``config.example.toml`` to ```config.toml`` and customize the values in the config file. YAML works as well, if you'd like to use that instead.
2022-07-28 14:50:41 +05:30
2022-08-02 14:11:17 +05:30
We recommend using Docker as it provides better security (we suck in security, so that's why) and we are constantly updating Segfautils. Docker makes it easy to update the program.
2022-07-28 14:50:41 +05:30
2022-08-02 14:11:17 +05:30
If you're using Portainer, you should know how to add Segfautils.
2022-07-28 14:50:41 +05:30
### Manual (recommended for development)
```
2022-08-02 14:11:17 +05:30
git clone https://github.com/ProjectSegfault/segfautils
cd segfautils/
# You need to add the environment HCAPTCHA_SITE_KEY, HCAPTCHA_SECRET_KEY, SEGFAUTILS_WEBHOOK_URL and SEGFAUTILS_PORT.
go run main.go # Run this when you've done above, and you're planning on developing, if not, do below
go build . -o segfautils
./segfautils
2022-08-15 01:04:56 +05:30
```