Mercurial > Pritunl-Fake-API

comparison README.md @ 0:b51518614818 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
New Files
author Pluto <meokcin@gmail.com>
date Tue, 03 Sep 2024 15:57:25 +0800
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:b51518614818
1 # What is this? #
2 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.
3
4 ## How to setup (server) ##
5 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.
6 Then you'll need to execute the `setup.py` script (preferable as `root`, as it needs to modify the Pritunl files directly).
7 After that log in into the dashboard - there should be a "Update Notification":
8
9 ![login-msg](docs/login-msg.png)
10
11 Now try to enter any serial key for your subscription and just follow the hints/notes if you enter an invalid command:
12
13 ![enter-something](docs/enter-something.png)
14
15 A valid command would be `bad premium` or `active ultimate`:
16
17 ![active-ultimate](docs/active-ultimate.png)
18
19 If everything worked, your subscription should now look like this:
20
21 ![done](docs/done.png)
22
23 Make sure to support the developers by buying the choosen subscription for your enterprise or company!
24
25 ## How to setup (api) (optional) ##
26 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.
27
28 ## API Only: Using Apache
29 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.
30 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!
31
32 ### API Only: Using Nginx
33 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.
34 See the documentation in [Nginx Install](docs/nginx/install.md).
35
36 ### API Only: Using Docker
37 See the documentation in [Docker Install](docs/docker/api-only-install.md).
38
39 ### Fully Patched Pritunl: Using Docker
40 This api has also its own docker image. Take a look into the `docker` folder and enjoy!
41
42 See the documentation in [Patched Pritunl Docker Install](docs/docker/pritunl-patched-install.md).
43
44 ### Nett2Know ###
45 * This modification will also block any communication to the Pritunl servers - so no calling home :)
46 * 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).
47
48 Have fun with your new premium/enterprise/ultimate Pritunl instance!