Readme

MYANYTHINGLIST GODADDY DOMAIN STEWARD
=====================================

Purpose
-------

Private PHP + JavaScript tool for exporting a GoDaddy domain inventory CSV/JSON
so domain owners can classify names as keep, sell, donate, return/drop, or review
before renewal.

This package is intended to be open source. It contains no API keys.

API keys belong only in:

  config/credentials.local.json

That file is intentionally excluded by .gitignore.

Important
---------

This is read-only. It does not cancel, delete, renew, transfer, auction, or edit
domains.

Why this exists
---------------

Domain owners need a simple, exportable list of domains, renewal dates, auto-renew
status, and estimated renewal exposure. Clicking through domains one by one is a
time-and-motion tax, especially for disabled people, neurodivergent people, small
creators, nonprofit projects, educators, and anyone trying to avoid accidental
renewal fees.

Why PHP
-------

A browser-only JavaScript app would expose API keys. This PHP version keeps the
GoDaddy API key and secret on the private server side.

What it exports
---------------

domain
tld
status
expires
days_until_expiration
renew_auto
renewable
estimated_annual_renewal_usd
estimated_due_next_365_days_usd
project_bucket
recommended_action
notes

Setup
-----

1. Copy:

   config/credentials.example.json

   to:

   config/credentials.local.json

2. Put your GoDaddy production API key and secret into credentials.local.json.

3. Edit:

   config/settings.json

4. Upload this project to a private VPS path.

5. Protect it with at least one of:

   HTTP Basic Auth
   VPN
   private/no-A-record host
   IP allowlist
   SSH-only command line use

6. Open:

   public/index.php

Command line export
-------------------

From the package root:

  php public/export-cli.php

Outputs are saved under:

  exports/

Open source safety rule
-----------------------

Commit source files, example config, docs, and code.

Never commit:

  config/credentials.local.json
  real API keys
  private exports unless intentionally published after review

Documentation format rule
-------------------------

No required Markdown.

Use:

  .txt
  .html
  .json
  .php
  .js