API for our upcoming pubnix. Maintained by @Odyssium and @arya

Go to file

Arya Kiran 992a11d35f add ssh option to README usage		2023-01-17 20:38:08 +05:30
pages	add ssh key value for signup	2023-01-17 20:36:47 +05:30
.gitignore	remove binary wtf	2023-01-07 19:16:48 +01:00
go.mod	don't depend on wc for online user count; wip meta info in json	2023-01-17 19:35:28 +05:30
go.sum	don't depend on wc for online user count; wip meta info in json	2023-01-17 19:35:28 +05:30
LICENSE	Arya fix it	2023-01-07 16:33:51 +01:00
main.go	add ssh key value for signup	2023-01-17 20:36:47 +05:30
README.md	add ssh option to README usage	2023-01-17 20:38:08 +05:30

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_SHOUTRRRURL in order for notifications to work. Url Format can be found at https://containrrr.dev/shoutrrr/v0.5/services/matrix/

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

ROUTE	TYPE	EXTRA ARGS	DESCRIPTION
/online	GET	N/A	Returns the number of online users
/signup	POST	username, email, ssh	Creates a register script and notifies admins that a new registration request was sent. Note: SSH Key must be sent in base64 form