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
Midou36O e72719f6b0
ci/woodpecker/push/woodpecker Pipeline was successful Details
Merge options-pub into oauth
2022-09-19 17:34:59 +01:00
.github Update docker.yml 2022-09-15 17:37:33 +00:00
api Merge options-pub into oauth 2022-09-19 17:34:59 +01:00
config Merge options-pub into oauth 2022-09-19 17:34:59 +01:00
data Merge options-pub into oauth 2022-09-19 17:34:59 +01:00
static Finished. 2022-09-14 14:32:56 +01:00
utils Broken mess, got to fix. 2022-09-16 23:10:37 +01:00
.gitignore Make it compatible with the previous version. 2022-09-18 19:16:57 +01:00
.woodpecker.yml Merge options-pub into oauth 2022-09-19 17:34:59 +01:00
Dockerfile Rename to Segfautils 2022-08-02 10:42:47 +02:00
LICENSE Update LICENSE 2022-09-12 19:16:24 +00: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
go.mod Initial OAuth draft. 2022-09-14 15:55:17 +01:00
go.sum Initial OAuth Draft 2022-09-14 15:56:59 +01:00
main.go Fix everything odyssey pointed out. 2022-09-18 17:44:37 +01:00
readme.md Broken mess, got to fix. 2022-09-16 23:10:37 +01:00

readme.md

Segfautils

Web utilities for Project Segfault

What does it do?

For now it powers our contact form and our announcements page. In the future we will expand our APIs so you can do more cool things. (We currently do not have any new idea so please open issues and give us suggestions!!)

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 config file located in data/config.toml. 
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