From 5a0726ea3f1fb107b3d7759f62d4f1769b2b1ff1 Mon Sep 17 00:00:00 2001 From: Odyssey346 Date: Thu, 28 Jul 2022 11:20:41 +0200 Subject: [PATCH] a readme never seen b4 Signed-off-by: Odyssey346 --- readme.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 readme.md diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..6b7d561 --- /dev/null +++ b/readme.md @@ -0,0 +1,32 @@ +# Segfautilities +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 segfautilities projectsegfault/segfautilities:latest -e HCAPTCHA_SITE_KEY='YOURSITEKEY' -e HCAPTCHA_SECRET_KEY='YOURSECRETKEY' -e SEGFAUTILITIES_WEBHOOK_URL='YOURWEBHOOKURL' +``` + +We recommend using Docker as it provides better security (we suck in security, so that's why) and we are constantly updating Segfautilities. Docker makes it easy to update the program. + +If you're using Portainer, you should know how to add Segfautilities. + +### Manual (recommended for development) +``` +git clone https://github.com/ProjectSegfault/segfautilities +cd segfautilities/ +# You need to add the environment HCAPTCHA_SITE_KEY, HCAPTCHA_SECRET_KEY, SEGFAUTILITIES_WEBHOOK_URL and SEGFAUTILITIES_PORT. +go run main.go # Run this when you've done above! +``` +#### NixOS +``` +git clone https://github.com/ProjectSegfault/segfautilities +cd segfautilities/ +nix-shell # Avoid installing Go and setting up the web port, by just running a nix shell +# You still need the environment variables HCAPTCHA_SITE_KEY, HCAPTCHA_SECRET_KEY and SEGFAUTILITIES_WEBHOOK_URL though! +go run main.go # I wonder if this is good practice or not. If this isn't good practice, make a GitHub issue please. +```