Download the PHP package michaelesmith/dyndns-kit without Composer
On this page you can find all versions of the php package michaelesmith/dyndns-kit. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download michaelesmith/dyndns-kit
More information about michaelesmith/dyndns-kit
Files in michaelesmith/dyndns-kit
Package dyndns-kit
Short Description a framework for creating a dyn dns compatible server
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package dyndns-kit
What is this?
This is a framework that will allow you to easily create and use a simple DynDNS implementation in PHP while being easily hackable to add new features and processors. This project was born out of my frustration in trying to find a simple PHP DynDNS implementation that would allow me to use Digital Ocean as the backend DNS. This project solved my problem, hopefully it will be useful to someone else.
Install
composer require "michaelesmith/dyndns-kit"
Overview
Server: basic unit that will try to execute a request
Handler: operates on a specific type of request. A generic handler for typical dyndns requests is provided but you could create one to handle API request for instance.Transformer: this transforms a raw request into aQueryAuthenicator: this allows us to authenticate the request based on many factors. The included authenticator will use an http basic username and password and can limit users to specific domains.Processor: this processes our given query and stores the result.
How do I use it
To see a full example usage please refer to the example project.
Basic usage
In this example we use only a single GenericHandler, the standard DynDNSTransformer, the HttpBasicAuthenticator with a single user that will allow any domain and the included JsonProcessor. The JsonProcessor is probably not very useful in real life but it allows us to easily test this setup without the need for other components. Using the curl example below will create the file dns.json and store the address in it.
More advanced usage
This example uses the exact same setup as before except for the processor. Here we use a caching processor so only new or updated requests are actually sent to the embedded processor which in this case updates the DNS entry for a domain hosted at Digital Ocean.
Try it out
Example curl command
curl "testuser:s3cret@localhost:9001/nic/update?hostname=test.example.com&myip=127.0.0.1"
Example with multiple hosts
curl "testuser:s3cret@localhost:9001/nic/update?hostname=test1.example.com,test2.example.com&myip=127.0.0.1"
Example without IP (if no IP is given the client IP address will be used)
curl "testuser:s3cret@localhost:9001/nic/update?hostname=test.example.com"
Other processors
- Cache - allows an embedded processor to only be called with new or updated requests
- DigitalOcean - allows the you to update dns entries via the Digital Ocean API
Contributing
Have an idea to make something better? Submit a pull request. Need integration of some other backend service? Build it. I would be happy to add a link here. PR's make the open source world turn. :earth_americas: :earth_asia: :earth_africa: :octocat: Happy Coding!
