Create subdomains, for free.
Introduction · Features · Deployment · Documentation · FAQ
2Peek.Me (also 2pme) is a free and opensource dns manager to manage subdomains via cloudflare.
2pme provides a full https api with simple api keys managment, where everyone can get unlimited subdomains for free.
Here are few simple steps to easily deploy 2pme api for your own domain.
Please be sure your hosting platform has the following software installed:
| Component | Software/Extension | Minimum Recommended Version | Notes |
|---|---|---|---|
| Web Server | Apache | 2.4+ | Or Nginx (1.18+) configured with php-fpm. |
| Nginx | 1.18+ | Ensure PHP is properly integrated. | |
| PHP | PHP | 7.4+ (8.1 recommended) | PHP must include the following extensions: |
mysqli Extension |
Included in PHP | For connecting to MySQL. | |
json Extension |
Included in PHP | For encoding and decoding JSON data. | |
| Database | MySQL | 5.7+ (8.0 recommended) | Or MariaDB (10.3+). |
| SSL/TLS | SSL Certificate | Required for HTTPS | Use Let's Encrypt or another certificate provider. |
Use the following command to clone this repository
$ git clone https://github.com/douxxu/2pme-apiFind and open the file located at src/api/utils/secrets.php and edit the variable content following the given instructions. Make sure you have your domain name servers parked on cloudflare.
Upload all the directories that are in src/ into your file server (can be in a subdir like api/, not in root).
Your 2pme api is now installed !
Yes, you can find it on NPM or make your own version out of the Source code.
Not actually, but it will probably be made.
No, and i'm not planing to make one. You can easily use the requests module and the documentation to make one yourself.
This project (and all other related projects) is licensed under the GPL-3.0 license.