This repository has been archived on 2022-10-30. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
2022-09-13 14:09:32 +01:00
.github Rename to Segfautils 2022-08-02 10:42:47 +02:00
api Initial refactor of settings. 2022-08-14 21:06:00 +02:00
config hopefully fix issues 2022-08-24 19:54:46 +02:00
data exmaplke 2022-08-14 21:21:00 +02:00
static remove the required tag 2022-09-13 14:09:32 +01:00
utils Initial refactor of settings. 2022-08-14 21:06:00 +02:00
.woodpecker.yml remove some events 2022-08-12 21:54:05 +01:00
docker-compose.yml Initial docker compose file. MIght need work 2022-08-23 22:16:47 +02:00
docker.env add to docker.env 2022-08-04 21:20:21 +02:00
Dockerfile Rename to Segfautils 2022-08-02 10:42:47 +02:00
go.mod Initial refactor of settings. 2022-08-14 21:06:00 +02:00
go.sum Initial refactor of settings. 2022-08-14 21:06:00 +02:00
LICENSE Update LICENSE 2022-09-12 19:16:24 +00:00
main.go Initial refactor of settings. 2022-08-14 21:06:00 +02:00
readme.md okay, Akissvart 2022-08-14 21:34:56 +02:00

Segfautils

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

Docker:

docker run -d --restart=always -p 6893:6893 --name segfautils -v "$(pwd)"/data:/segfautils/data projectsegfault/segfautils:latest

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.

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.

If you're using Portainer, you should know how to add Segfautils.

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