Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/douxxu/2pme-api
2Peek.Me - Create subdomains, for free.
https://github.com/douxxu/2pme-api
api backend cloudflare explore free good-first-issue good-first-pr http managment subdomain
Last synced: about 2 months ago
JSON representation
2Peek.Me - Create subdomains, for free.
- Host: GitHub
- URL: https://github.com/douxxu/2pme-api
- Owner: douxxu
- License: gpl-3.0
- Created: 2024-12-13T21:20:05.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-12-13T21:25:25.000Z (about 2 months ago)
- Last Synced: 2024-12-13T22:24:50.483Z (about 2 months ago)
- Topics: api, backend, cloudflare, explore, free, good-first-issue, good-first-pr, http, managment, subdomain
- Language: PHP
- Homepage: https://2peek.me
- Size: 184 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Create subdomains, for free.
Introduction ·
Features ·
Deployment ·
Documentation ·
FAQ
## Introduction
`2Peek.Me` (also `2pme`) is a free and opensource dns manager to manage subdomains via cloudflare.
## Features
2pme provides a full https api with simple api keys managment, where everyone can get unlimited subdomains for free.
## Deployment
Here are few simple steps to easily deploy 2pme api for your own domain.
### 1. Requirements
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. |
### 2: Clone this repository locally
Use the following command to clone this repository
```sh
$ git clone https://github.com/douxxu/2pme-api
```
### 3: Update the secrets.php file
Find 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](https://dash.cloudflare.com).
### 4: Deploy your api
Upload all the directories that are in `src/` into your file server (can be in a subdir like `api/`, not in root).
### 5: Enjoy !
Your 2pme api is now installed !
## FAQ
### Is there a command line tool to manage subdomains ?
**Yes**, you can find it on [NPM](https://npmjs.com/package/2pme) or make your own version out of the [Source code](https://git.douxx.tech/2pme-cli).
### Is there a dashboard to manage subdomains ?
**Not actually**, but it will probably be made.
### Is there a python api wrapper ?
**No**, and i'm not planing to make one. You can easily use the `requests` module and the [documentation](https://2peek.me) to make one yourself.
## License
This project (and all other related projects) is licensed under the [GPL-3.0](LICENSE) license.
