{"id":22927032,"url":"https://github.com/douxxu/2pme-api","last_synced_at":"2025-05-13T01:45:17.546Z","repository":{"id":268026819,"uuid":"903063905","full_name":"douxxu/2pme-api","owner":"douxxu","description":"2Peek.Me - Create subdomains, for free.","archived":false,"fork":false,"pushed_at":"2024-12-13T21:25:25.000Z","size":188,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-13T22:24:50.483Z","etag":null,"topics":["api","backend","cloudflare","explore","free","good-first-issue","good-first-pr","http","managment","subdomain"],"latest_commit_sha":null,"homepage":"https://2peek.me","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/douxxu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-13T21:20:05.000Z","updated_at":"2024-12-13T21:39:22.000Z","dependencies_parsed_at":"2024-12-13T22:24:53.583Z","dependency_job_id":"220bbabd-068c-4e2b-8e10-da9018a88ec4","html_url":"https://github.com/douxxu/2pme-api","commit_stats":null,"previous_names":["douxxu/2pme-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/douxxu%2F2pme-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/douxxu%2F2pme-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/douxxu%2F2pme-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/douxxu%2F2pme-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/douxxu","download_url":"https://codeload.github.com/douxxu/2pme-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229683947,"owners_count":18107131,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","backend","cloudflare","explore","free","good-first-issue","good-first-pr","http","managment","subdomain"],"created_at":"2024-12-14T09:12:53.502Z","updated_at":"2024-12-14T09:12:53.930Z","avatar_url":"https://github.com/douxxu.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n\u003ca href=\"https://2peek.me\" style=\"display: block; text-align: center;\"\u003e\n  \u003cimg alt=\"2Peek.Me - Create subdomains, for free.\" src=\"readme_assets/2pmebanner.png\" /\u003e\n  \u003ch1 align=\"center\"\u003e2Peek.Me\u003c/h1\u003e\n\u003c/a\u003e\n\n\u003c/div\u003e\n\u003cp align=\"center\"\u003e\n  Create subdomains, for free.\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#introduction\"\u003e\u003cstrong\u003eIntroduction\u003c/strong\u003e\u003c/a\u003e ·\n  \u003ca href=\"#features\"\u003e\u003cstrong\u003eFeatures\u003c/strong\u003e\u003c/a\u003e ·\n  \u003ca href=\"#deployment\"\u003e\u003cstrong\u003eDeployment\u003c/strong\u003e\u003c/a\u003e ·\n  \u003ca href=\"https://2peek.me\"\u003e\u003cstrong\u003eDocumentation\u003c/strong\u003e\u003c/a\u003e ·\n  \u003ca href=\"#faq\"\u003e\u003cstrong\u003eFAQ\u003c/strong\u003e\u003c/a\u003e\n\u003c/p\u003e\n\u003cbr/\u003e\n\n## Introduction\n\n`2Peek.Me` (also `2pme`) is a free and opensource dns manager to manage subdomains via cloudflare.\n\n## Features\n\n2pme provides a full https api with simple api keys managment, where everyone can get unlimited subdomains for free.\n\n## Deployment\n\nHere are few simple steps to easily deploy 2pme api for your own domain.\n\n### 1. Requirements\nPlease be sure your hosting platform has the following software installed:\n\n| **Component**              | **Software/Extension**              | **Minimum Recommended Version** | **Notes**                                                                                 |\n|----------------------------|-------------------------------------|----------------------------------|-------------------------------------------------------------------------------------------|\n| **Web Server**             | Apache                              | 2.4+                             | Or Nginx (1.18+) configured with `php-fpm`.                                              |\n|                            | Nginx                               | 1.18+                            | Ensure PHP is properly integrated.                                                        |\n| **PHP**                    | PHP                                 | 7.4+ (8.1 recommended)           | PHP must include the following extensions:                                                |\n|                            | `mysqli` Extension                  | Included in PHP                  | For connecting to MySQL.                                                                  |\n|                            | `json` Extension                    | Included in PHP                  | For encoding and decoding JSON data.                                                     |\n| **Database**               | MySQL                               | 5.7+ (8.0 recommended)           | Or MariaDB (10.3+).                                                                          |\n| **SSL/TLS**                | SSL Certificate                     | Required for HTTPS               | Use Let's Encrypt or another certificate provider.                                        |\n\n\n### 2: Clone this repository locally\nUse the following command to clone this repository\n```sh\n$ git clone https://github.com/douxxu/2pme-api\n```\n\n### 3: Update the secrets.php file\nFind 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).\n\n### 4: Deploy your api\nUpload all the directories that are in `src/` into your file server (can be in a subdir like `api/`, not in root).\n\n### 5: Enjoy !\nYour 2pme api is now installed !\n\n## FAQ\n\n### Is there a command line tool to manage subdomains ?\n**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).\n\n### Is there a dashboard to manage subdomains ?\n**Not actually**, but it will probably be made.\n\n### Is there a python api wrapper ?\n**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.\n\n## License\nThis project (and all other related projects) is licensed under the [GPL-3.0](LICENSE) license.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdouxxu%2F2pme-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdouxxu%2F2pme-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdouxxu%2F2pme-api/lists"}