2pme api

2PEEK.ME

Créez des sous-domaines, gratuitement.

Introduction · Fonctionnalités · Déploiement · Documentation · FAQ

Introduction

2Peek.Me (également 2pme ) est un gestionnaire DNS gratuit et OpenSource pour gérer les sous-domaines via CloudFlare.

Caractéristiques

2PME fournit une API HTTPS complète avec la gestion simple des touches API, où tout le monde peut obtenir des sous-domaines illimités gratuitement.

Déploiement

Voici quelques étapes simples pour déployer facilement l'API 2PME pour votre propre domaine.

1. Exigences

Veuillez vous assurer que votre plateforme d'hébergement a installé le logiciel suivant:

Composant	Logiciel / extension	Version minimale recommandée	Notes
Serveur Web	Apache	2.4+	Ou nginx (1.18+) configuré avec php-fpm .
	Nginx	1.18+	Assurez-vous que PHP est correctement intégré.
Php	Php	7.4+ (8.1 recommandé)	PHP doit inclure les extensions suivantes:
	extension mysqli	Inclus dans PHP	Pour se connecter à MySQL.
	Extension json	Inclus dans PHP	Pour l'encodage et le décodage des données JSON.
Base de données	Mysql	5.7+ (8.0 recommandé)	Ou mariaDB (10.3+).
SSL / TLS	Certificat SSL	Requis pour HTTPS	Utilisez Let's Encrypt ou un autre fournisseur de certificat.

2: cloner ce référentiel localement

Utilisez la commande suivante pour cloner ce référentiel

$ git clone https://github.com/douxxu/2pme-api

3: Mettez à jour le fichier secrets.php

Trouvez et ouvrez le fichier situé sur src/api/utils/secrets.php et modifiez le contenu variable en suivant les instructions données. Assurez-vous que vos serveurs de noms de domaine sont stationnés sur CloudFlare.

4: Déployez votre API

Téléchargez tous les répertoires qui sont dans src/ dans votre serveur de fichiers (peut être dans un sous-dir comme api/ , pas dans Root).

5: Profitez-en!

Votre API 2PME est maintenant installée!

FAQ

Y a-t-il un outil de ligne de commande pour gérer les sous-domaines?

Oui , vous pouvez le trouver sur NPM ou créer votre propre version à partir du code source.

Y a-t-il un tableau de bord pour gérer les sous-domaines?

Pas vraiment , mais il sera probablement fait.

Y a-t-il un wrapper API Python?

Non , et je ne prévois pas en faire un. Vous pouvez facilement utiliser le module requests et la documentation pour en faire un vous-même.

Licence

Ce projet (et tous les autres projets connexes) est licencié en vertu de la licence GPL-3.0.