2pme api

2peek.me

無料でサブドメインを作成します。

はじめに・機能・展開・ドキュメント・FAQ

導入

2Peek.Me （また2pme ）は、Cloudflareを介してサブドメインを管理するための無料でOpenSource DNSマネージャーです。

特徴

2PMEは、シンプルなAPIキーマネジメントを備えた完全なHTTPS APIを提供します。ここでは、誰もが無制限のサブドメインを無料で取得できます。

展開

2pme APIを独自のドメインに簡単に展開する簡単な手順をいくつか紹介します。

1。要件

ホスティングプラットフォームに次のソフトウェアがインストールされていることを確認してください。

成分	ソフトウェア/拡張機能	最小推奨バージョン	メモ
Webサーバー	アパッチ	2.4+	または、 php-fpmで構成されたnginx（1.18+）。
	nginx	1.18+	PHPが適切に統合されていることを確認してください。
Php	Php	7.4+（8.1推奨）	PHPには、次の拡張機能を含める必要があります。
	mysqli拡張機能	PHPに含まれています	mysqlに接続するため。
	json拡張機能	PHPに含まれています	JSONデータのエンコードとデコード用。
データベース	mysql	5.7+（8.0推奨）	またはMariadb（10.3+）。
SSL/TLS	SSL証明書	HTTPSに必要です	Let's Encryptまたは別の証明書プロバイダーを使用します。

2：このリポジトリをローカルにクローンします

次のコマンドを使用して、このリポジトリをクローンします

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

3：secrets.phpファイルを更新します

src/api/utils/secrets.phpにあるファイルを見つけて開き、指定された指示に従って変数コンテンツを編集します。 CloudFlareにドメイン名サーバーが駐車されていることを確認してください。

4：APIを展開します

src/にあるすべてのディレクトリをファイルサーバーにアップロードします（rootではなく、 api/のようなサブディールになります）。

5：お楽しみください！

2pme APIがインストールされました！

よくある質問

サブドメインを管理するコマンドラインツールはありますか？

はい、NPMで見つけたり、ソースコードから独自のバージョンを作成したりできます。

サブドメインを管理するダッシュボードはありますか？

実際にはそうではありませんが、おそらく作られるでしょう。

Python APIラッパーはありますか？

いいえ、私はそれを作るつもりはありません。 requestsモジュールとドキュメントを簡単に使用して自分で作成できます。

ライセンス

このプロジェクト（および他のすべての関連プロジェクト）は、GPL-3.0ライセンスの下でライセンスされています。