API for our pubnix

Go to file

Arya Kiran 360b96b40a remove hcaptcha testing stuff from /users		2023-07-11 20:00:45 +05:30
examples	send user email once registration is sent	2023-02-05 19:00:47 +05:30
pages	remove hcaptcha testing stuff from /users	2023-07-11 20:00:45 +05:30
utils	add todo to signup email	2023-03-06 19:40:53 +05:30
.gitignore
go.mod	Require a captcha on the backend	2023-07-10 22:23:29 +01:00
go.sum	Require a captcha on the backend	2023-07-10 22:23:29 +01:00
LICENSE
main.go	try fixing ip issue	2023-02-18 10:24:36 +01:00
publapi.env	add notif after user is created	2023-03-01 19:16:53 +05:30
README.md	feat: add go link	2023-05-28 15:42:21 +02:00

README.md

PublAPI

PublAPI is a simple API for Project Segfault's upcoming public shared system (pubnix).

Install

An installation of Go 1.19 or higher is required.

git clone https://github.com/ProjectSegfault/publapi
go mod download 
go build 
./publapi

By default publapi listens on 127.0.0.1:3000. You can change the port with the environment variable PUBLAPI_PORT.

Additionally, you need to set the variable PUBLAPI_EMAIL_SHOUTRRRURL and PUBLAPI_NOTIFY_SHOUTRRRURL in order for signup notifications to work. URL Format can be found at https://containrrr.dev/shoutrrr/v0.5.

You can also set PUBLAPI_SIGNUP_IP to make sure signup requests can only be made from one IP.

Usage

Currently, PublAPI has only two routes, /users and /signup.

ROUTE	TYPE	EXTRA ARGS	DESCRIPTION
/users	GET	N/A	Return information about users.
/signup	POST	username, email, ssh	Creates a register script and notifies admins that a new registration request was sent.