Skip to content

dotzenith/Septum

Repository files navigation

━━━━━━ ❖ ━━━━━━



❖ Information

Septum is a free API that aims to augment Septa's Public API with useful endpoints that it lacks.


❖ Usage

The Base URL is:

https://septum.jawn.website/api

Please see the docs for usage of the various endpoints


❖ Rate Limiting

Septum currently allows 5 requests per minute from a given IP address. In case you desire more, feel free to take a look at the Self Hosting section.


❖ Self Hosting

Septum is relatively easy to self-host. The only requirements are Docker, Git and pretty much any webserver, for example: nginx

❖ Clone repo and cd into it

git clone https://github.com/dotzenith/Septum.git
cd Septum

❖ Build the image and run the container

docker compose up --build -d

❖ Set up a reverse proxy

After the step above, set up a reverse proxy using a webserver of your choice and enjoy your very own Septum API :)


❖ What's New?

0.2.2 - Update and fix tests


About

An API to augment endpoints that I wish Septa provided

Resources

License

Stars

Watchers

Forks

Packages

No packages published