mirror of
https://github.com/simonmicro/Pritunl-Fake-API.git
synced 2026-06-27 22:24:56 -04:00
60 lines
4.0 KiB
Markdown
60 lines
4.0 KiB
Markdown
# This Project Has Reached End-of-Life (EOL)
|
|
If you want to get the full story: https://github.com/simonmicro/Pritunl-Fake-API/issues/44
|
|
|
|
**TL;DR:** I haven't used Pritunl for over five years now and have only continued maintaining this repository because I enjoyed working on it. As a result, the project unintentionally entered a long-term support (LTS) phase, receiving no major new features and only essential bug fixes. In March 2026, I moved the project into its **End-of-Support** phase. Since then, no further changes have been made while I searched for someone to take over maintenance. As of **2026-07-01**, I am ending that extended search for a successor. Since no new maintainer has stepped forward, the project is now officially entering its **End-of-Life (EOL)** phase.
|
|
|
|
If you are still using this project, you should start hosting your own instance. The public instance will be shut down soon after a short grace period.
|
|
|
|
_So Long, and Thanks for All the Fish 🫡_
|
|
|
|
---
|
|
|
|
# What is this? #
|
|
This neat script provides a little fake API to unlock all premium/enterprise/enterprise+ (here called ultimate) features of your own Pritunl VPN server. If Pritunl wouldn't be mostly free already, you could call this a crack. An Open Source crack.
|
|
|
|
## How to setup (server) ##
|
|
Take a look into the `server` folder: You _could_ use the Pritunl source there (or just download this specific version from their GitHub repo) to compile a guaranteed compatible version for this API or just download any other version of the Pritunl server and try your luck.
|
|
Then you'll need to execute the `setup.py` script (preferable as `root`, as it needs to modify the Pritunl files directly).
|
|
After that log in into the dashboard - there should be a "Update Notification":
|
|
|
|
|
|
|
|
Now try to enter any serial key for your subscription and just follow the hints/notes if you enter an invalid command:
|
|
|
|
|
|
|
|
A valid command would be `bad premium` or `active ultimate`:
|
|
|
|
|
|
|
|
If everything worked, your subscription should now look like this:
|
|
|
|
|
|
|
|
Make sure to support the developers by buying the choosen subscription for your enterprise or company!
|
|
|
|
## How to setup (api) (optional) ##
|
|
This is _optional_. You can simply use the default instance of this API (host is noted inside the `setup.py` script) and profit from "automatic" updates.
|
|
|
|
## API Only: Using Apache
|
|
Just transfer the `www` files inside a public accessible root-folder on your _dedicated_ Apache webserver (really everthing with PHP support works). Also make sure your instance has a valid SSL-certificate (Let's encrypt is enough), otherwise it may won't work.
|
|
An example Apache install process can be found [here](docs/apache/install.md). If you want to test your instance, just open the public accessible URI in your browser and append `/healthz` to it - if you see some JSON with the text, then everything worked!
|
|
|
|
### API Only: Using Nginx
|
|
Just transfer the `www` files inside a public accessible root-folder on your _dedicated_ Nginx webserver (really everthing with PHP support works). Also make sure your instance has a valid SSL-certificate (Let's encrypt is enough), otherwise it may won't work.
|
|
See the documentation in [Nginx Install](docs/nginx/install.md).
|
|
|
|
### API Only: Using Docker
|
|
See the documentation in [Docker Install](docs/docker/api-only-install.md).
|
|
|
|
### Fully Patched Pritunl: Using Docker
|
|
This api has also its own docker image. Take a look into the `docker` folder and enjoy!
|
|
|
|
See the documentation in [Patched Pritunl Docker Install](docs/docker/pritunl-patched-install.md).
|
|
|
|
### Nett2Know ###
|
|
* This modification will also block any communication to the Pritunl servers - so no calling home :)
|
|
* SSO will not work with this api version! As Pritunls own authentication servers handle the whole SSO stuff, track instance ids and verify users, I won't implement this part for privacy concerns (and also this would need to be securly implemented and a database).
|
|
|
|
Have fun with your new premium/enterprise/ultimate Pritunl instance!
|