Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
daplie-tools
Advanced tools
daplie-tools - npm Package Compare versions
Comparing version 1.0.0-alpha.909 to 1.0.0-alpha.910
| { | ||
| "name": "daplie-tools", | ||
| "version": "1.0.0-alpha.909", | ||
| "version": "1.0.0-alpha.910", | ||
| "description": "Taking back the Internet", | ||
@@ -35,5 +35,5 @@ "main": "index.js", | ||
| "commander": "^2.9.0", | ||
| "oauth3-cli": "git+https://github.com/OAuth3/oauth3-cli.git#v1.0.0-alpha.908", | ||
| "oauth3-cli": "git+https://github.com/OAuth3/oauth3-cli.git#v1.0.0-alpha.910", | ||
| "request": "^2.69.0" | ||
| } | ||
| } |
291
README.md
@@ -1,44 +0,292 @@ | ||
| # daplie-tools | ||
| Taking Back the Internet | ||
| # Daplie Tools | ||
| Taking Back the Internet! | ||
| https://daplie.com/articles/introducing-daplie/ | ||
| ## What is it? | ||
| That's what we're doing and that's what these tools are for. | ||
| daplie-tools is a CLI client for DDNS and domain purchases. This is alpha software, NOT FOR PRODUCTION USE! | ||
| ## What can I do with 'em? | ||
| ## Prerequisities | ||
| `daplie-tools` is a CLI suite of tools for managing Internet infrastructure: | ||
| First you need to install cURL and Git. You can install them using apt-get with this command: | ||
| * Manage Domains | ||
| * purchaes your own domain | ||
| * transfer from your current registrar | ||
| * get a `daplie.me` subdomain | ||
| `apt-get install --yes git curl` | ||
| * Manage DNS | ||
| * Glue Records | ||
| * Domain Nameservers | ||
| * Static Record Types (CNAME, MX, SRV, TXT) | ||
| * Device (server) Record Types (A, AAAA) | ||
| Then you need to install Node.js You can install it on OS X or Linux with this command: | ||
| * Dynamic DNS (DDNS) | ||
| * Managed with Device API | ||
| `curl -sL bit.ly/nodejs-min | bash` | ||
| (NAT automation and Reverse VPN purchase are planned for the future) | ||
| If you don't want to use the piped script you can download nodejs here: https://nodejs.org/en/download/ | ||
|  | ||
| ## Installation | ||
| # Install | ||
| You can install it by running: | ||
| This is **alpha software** (not quite beta yet). | ||
| `npm install -g daplie-tools` | ||
| We're intending this to be used by people that are happy to submit to us bug reports | ||
| and not give up when it doesn't work quite right. | ||
| ## Usage | ||
| (remember: computers are like people - no two are alike and although it works | ||
| as expected for everyone else, it will somehow fail for you) | ||
| `daplie COMMAND Command-Specific-Options` | ||
| **Minimal** | ||
| ## Commands | ||
| ```bash | ||
| # install node.js 4.3 or greater | ||
| curl -sL bit.ly/nodejs-min | bash | ||
| # install daplie-tools | ||
| npm install -g daplie-tools | ||
| ``` | ||
| Note: you will need `curl` and `git` installed. | ||
| **With Development Tools** | ||
| ``` | ||
| # install node.js 4.3 or greater | ||
| curl -sL bit.ly/nodejs-dev-install -o node-dev; bash ./node-dev | ||
| # install daplie-tools | ||
| npm install -g daplie-tools | ||
| ``` | ||
| If you don't want to use the scripts you can always download node.js here: https://nodejs.org/en/download/ | ||
| (but then you have to fix permissions on `/usr/local` and perhaps deal with quirks). | ||
| ## Windows | ||
| **completely untested** | ||
| Download the installer from https://nodejs.org/en/download/ | ||
| ```bash | ||
| npm install -g daplie-tools | ||
| ``` | ||
| In theory it'll work. Let us know. :) | ||
| # Walkthroughs & FAQs | ||
| * How do I get a **`daplie.me` domain**? | ||
| * How do I **purchase a domain**? | ||
| * How do I **transfer a domain**? | ||
| * How do I use **Dynamic DNS** with **Raspberry Pi**, etc? | ||
| * How do I **Manage DNS** with **Digital Ocean, Azure, AWS**, etc? | ||
| * Why do you require a Credit Card and address information for `daplie.me` subdomains? | ||
| * I have **a lot of users**, How can I "resell" my domain as Dynamic DNS? | ||
| * Can I use vanity nameservers? | ||
| ## Get a daplie.me subdomain | ||
| In short, you just enter the purchase console, type the domain you want, and end with `.daplie.me`: | ||
| ```bash | ||
| daplie domains:search | ||
| ``` | ||
|  | ||
| Oh, and you can also script the domain purchase directly: | ||
| ```bash | ||
| daplie help domains:search | ||
| daplie domains:search --domainnames "example.daplie.me" --tip 1 -max-purchase-price 1 | ||
| ``` | ||
| Note: although we don't check right now, excessive use of daplie.me domains will be reclaimed. | ||
| If you have a large number of users you would like to supply domains for, email aj@daplie.com | ||
| and I'll help you get your own domain set up for your users. | ||
| ## Purchase your own .com, .org, .net, etc | ||
| 1. Open the purchase console | ||
| 2. Type the name of the domain you want | ||
| 3. If it is not available the price turn into `N/A` | ||
| 4. Follow the prompts once you find an available domain | ||
| ```bash | ||
| daplie domains:search | ||
| ``` | ||
|  | ||
| Oh, and you can also script the domain purchase directly: | ||
| ```bash | ||
| daplie help domains:search | ||
| daplie domains:search --domainnames "example.daplie.me," --tip 1 -max-purchase-price 30 | ||
| ``` | ||
| ## Transfer a Domain | ||
| Before you can transfer a domain, there are a few things you need to do through | ||
| the company you bought it from: | ||
| 1. You must **TURN OFF WHOIS PRIVACY** | ||
| 2. You must **UNLOCK** your domain | ||
| 3. You must get an **EPP Transfer Code** (the name may vary by registrar) | ||
| 4. Copy your DNS records (copy and paste, screenshot, csv, whatever they offer) | ||
| Note: Usually your DNS records will remain active with your current company for | ||
| 2 weeks or more, but don't forget to transfer them over. | ||
| With the EPP code you can perform the transfer in this format: | ||
| ```bash | ||
| daplie domains:search --domainnames 'DOMAIN1:EPP1,DOMAIN2:EPP2' | ||
| ``` | ||
| Example: | ||
| ```bash | ||
| daplie domains:search --domainnames 'example.com:^%efea$#!0,example.net:afe187e7cc' | ||
| ``` | ||
| 1. It will take 1-10 days for the transfer to complete | ||
| 2. Make sure that you have added your DNS records to our nameservers (See Manage DNS section below) | ||
| 3. You must update the nameservers once the transfer completes | ||
| 4. Wait anywhere between a few minutes and a few days for the changes to propagate | ||
| Example: | ||
| ```bash | ||
| # Set the nameservers to Daplie defaults | ||
| daplie ns:set -n example.com --defaults | ||
| ``` | ||
| DO NOT DO THIS until you've copied the DNS records over (see the next section **Manage DNS**) | ||
| Or set custom nameservers like this: | ||
| ```bash | ||
| # See the help | ||
| daplie help ns | ||
| daplie help ns:set | ||
| # See the current nameservers | ||
| daplie ns:list -n example.com | ||
| # Set vanity nameservers | ||
| daplie ns:set -n example.com --nameservers 'ns1.example.com,ns2.example.com' | ||
| ``` | ||
| ## Manage DNS with Servers (Digital Ocean, Azure, AWS, etc) | ||
| 1. Set ip address to each device (names are arbitrary) | ||
| 2. Set the device to corresponding domains | ||
| 3. Set non-device records | ||
| ```bash | ||
| daplie devices:set --device 'aws-west-1' --addresses '127.0.0.1,::1' | ||
| daplie devices:attach --device 'aws-west-1' -n 'example.com' | ||
| # Example setting up mailgun | ||
| daplie dns:set -n example.com --type MX --answer mxa.mailgun.org --ttl 3600 | ||
| daplie dns:set -n example.com --type MX --answer mxb.mailgun.org --ttl 3600 | ||
| daplie dns:set -n mail.example.com --type CNAME --answer mailgun.org --ttl 3600 | ||
| ``` | ||
| Note: (ANAME and FWD records are not yet supported) | ||
| ## Dyanmic DNS with Raspberry Pi, Router, cron, etc | ||
| 1. Set ip address to each device (names are arbitrary) | ||
| 2. Set the device to corresponding domains | ||
| 3. Set non-device records | ||
| ```bash | ||
| daplie devices:set --device 'rpi2' --addresses '127.0.0.1,::1' | ||
| daplie devices:attach --device 'rpi2' -n 'example.com' | ||
| daplie devices:token --device 'rpi2' | ||
| ``` | ||
| Now schedule `cron` with a script to check your ip address every 5 minutes or so | ||
| and then run `curl` with the url+token if the ip has changed. | ||
| Note: (A more comprehensive `devices:update` method will be implemented soon) | ||
| ## Why do we require a credit card? | ||
| Many of the popular free DNS services are blocked by corporate, government, and school | ||
| firewalls because of abuse from non-paying anonymous users. | ||
| In order to ensure that our service remains available to all of our users | ||
| we require a valid credit card and physical address as a method of | ||
| deterring abusive and/or malicious users. | ||
| ## White-Label Subdomains and/or Dynamic DNS | ||
| You could offer your subdomains to your users in the same way that we offer `daplie.me` subdomains | ||
| for our users. | ||
| Right now that's a manual process. If you're interested contact aj@daplie.com. | ||
| ## Vanity Nameservers | ||
| More often than not, the company that you pay for your domain will set your nameservers | ||
| automatically to promote their brand, something like: `ns1.domainregistrar.com`, `ns2.domainregistrar.com`. | ||
| Vanity Nameservers promote your brand instead. So if you own `example.com` you would want the nameservers | ||
| `ns1.example.com`, `ns2.example.com`, etc. | ||
| Right now Daplie Domains uses generically branded nameservers, | ||
| but we plan to move to completely using Vanity Nameservers before our public launch. | ||
| To play with Vanity Nameservers | ||
| (WARNING: you may experience dns resolution issues while we are still in development) | ||
| you can set the nameserver glue records for your domain to us even today: | ||
| ```bash | ||
| daplie glue:set -n example.com --defaults | ||
| daplie ns:set -n example.com --nameservers 'ns1.example.com,ns2.example.com' | ||
| ``` | ||
| You can, of course, also use your own nameservers too: | ||
| Example: | ||
| ```bash | ||
| daplie glue:set -n ns1.example.com --address 127.0.0.1 | ||
| daplie glue:set -n ns2.example.com --address 127.0.0.2 | ||
| daplie ns:set -n example.com --nameservers 'ns1.example.com,ns2.example.com' | ||
| ``` | ||
| # Commands | ||
| See [COMMANDS.md](COMMANDS.md) | ||
| ## Authors | ||
| # Authors | ||
| daplie-tools is developed by <a href="https://github.com/coolaj86">AJ ONeal.</a> | ||
| ## Versioning | ||
| # Versioning | ||
| A strict version of semantic versioning is used. | ||
| This is an Alpha, so we really just bump the build version. | ||
| When it goes into RC is when we'll try to keep all of the command flags the same so that scripts you build won't break. | ||
| The format is: `v<major.minor.patch>-<class>+<build>` | ||
@@ -48,5 +296,4 @@ | ||
| # License | ||
| ## License | ||
| daplie-tools is licensed under the <a href="https://spdx.org/licenses/MPL-2.0">MPLv2</a> license. | ||
| `daplie-tools` is licensed under the <a href="https://spdx.org/licenses/MPL-2.0">MPLv2</a> license. |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Git dependency
Supply chain riskContains a dependency which resolves to a remote git URL. Dependencies fetched from git URLs are not immutable can be used to inject untrusted code or reduce the likelihood of a reproducible install.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Git dependency
Supply chain riskContains a dependency which resolves to a remote git URL. Dependencies fetched from git URLs are not immutable can be used to inject untrusted code or reduce the likelihood of a reproducible install.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by20.28%
42717
- Number of lines in readme file
- increased by475%
299