Quick start

StepsCopy Anchor Link

1. Complete the setup wizard: create the only account and the default cluster.
2. Enroll a node: generate the install command in the console and run it on the node host; once enrolled, the node connects to the node channel over mTLS.
3. Create a site: enter its domains, origin, and cache setting; the cluster publishes a new configuration revision.
4. Configure DNS: point the site's domains at the edge addresses or the CNAME target listed on the site's Domains tab in the authoritative DNS and wait for the records to take effect.
5. Enable HTTPS: click Enable HTTPS on the site's HTTPS tab; HTTPS turns on once the certificate is issued, see HTTPS and certificates.
6. Verify: every item of the Launch check on the site's Overview tab passes; check origin fetch and caching with curl.

Node installation, DNS propagation, and certificate issuance each take time that depends on the network and the providers.

PrerequisitesCopy Anchor Link

1. Complete the setup wizardCopy Anchor Link

1. Read the setup token from the console log. Docker Compose:

   Copy Text

   docker compose logs console | grep setupToken

   The log line is JSON: the setupToken field holds the token (prefix ews_) and the url field the setup page. An uninitialized console prints the same token at every start. For log locations of other deployment methods, see Docker Compose and BaoTa Panel and aaPanel.

2. Open EDGEWEIR_PUBLIC_URL in a browser. An uninitialized console redirects to /setup (Create your account).

3. Fill in the form and click Finish.

   Field	Description
   Setup token	The token from step 1
   Name	1–100 characters
   Email	Sign-in email
   Password	12–128 characters

4. Verify: the console signs in and opens Clusters & nodes with the Add node dialog of the cluster default (the next step); on System settings, the System card shows Setup token as Used {time}.

Objects created by setup:

2. Enroll a nodeCopy Anchor Link

1. Open Clusters & nodes, select the cluster default, and click Add node (open already after setup; while there is no node, the button at the top of the sidebar is Add node too). The dialog shows the Install command at once: default node group default, valid for 1 hour.

2. Optional: open Options, change the fields below, and click Regenerate.

   Field	Description
   Node name	Optional, at most 64 characters
   Node group	Defaults to the cluster's default node group; shown when the cluster has several
   Valid for	15 minutes, 1 hour (default), or 24 hours

3. Copy the Install command (shown once) and run it on the node host. The warnings and the node channel connection check below the command point out addresses nodes may not reach; see Adding nodes. Command format:

   Copy Text

   export EDGEWEIR_TOKEN='ewt_…'
   curl -fsSL https://console.example.com/install.sh | sudo --preserve-env=EDGEWEIR_TOKEN bash -s -- --server https://console.example.com:8443 --ca-sha256 <CA fingerprint>

4. Verify: every step of the dialog's Progress completes; the node appears in the node table of Clusters & nodes, Status is Online, and Applied shows In sync.

The token is single-use. For the installer's checks, the download mirror, and failure handling, see Adding nodes.

3. Create a siteCopy Anchor Link

1. Open Sites and click New site.

2. Fill in the form.

   Field	Default	Description
   Name	The first domain	At most 100 characters
   Domains	None	One per line or comma-separated; wildcards as *.example.com; 1–50 domains
   Origin	None	IP address or host name. Pasting a URL (https://origin.example.com:8443/app) or host:port puts the port and protocol into their own fields
   Port	80 (HTTP) / 443 (HTTPS)	Origin port
   Protocol	HTTP	HTTP or HTTPS
   Origin Host	Same as request	Host sent to the origin
   Caching	On	When on, creates one cache rule: Path prefix /, TTL (seconds) 3600, Respect origin Cache-Control on (3600 seconds when the origin sends neither Cache-Control nor Expires)

3. Click Create. The site's cluster publishes a new revision and the site page opens. The notice Site created follows the nodes: Rolling out N/M → Live on every node (Canary N/M, all nodes at HH:MM during a configuration canary).

For origin pools, cache rules, and cache keys, see Origins and cache.

4. Configure DNSCopy Anchor Link

Add a record for every site domain in the domain's authoritative DNS.

The card lists where each domain resolves now: Points here (every address belongs to a node of the cluster), Points elsewhere, Not resolved, Not checked (the lookup failed, or the nodes have no known address). A wildcard is resolved as edgeweir-check.<domain>. The card and the Launch check resolve again every 30 seconds; Check again beside the card's title resolves now. A recursive resolver's cached answer (also "no such name") holds until its TTL ends.

For lines, health-based removal, and TTL of DNS steering, see Configure DNS steering.

5. Enable HTTPSCopy Anchor Link

1. Open the site's HTTPS tab. Fix what the tab lists (for example records from step 4 that are not live yet) and click Check again.
2. Click Enable HTTPS. The console requests a certificate for all of the site's domains (a wildcard domain needs a DNS credential first); once issued, the site uses it. To redirect HTTP to HTTPS, turn on Redirect HTTP to HTTPS in the HTTPS settings afterwards.
3. The cluster publishes a new revision. Once an enabled site in the cluster uses a certificate, nodes listen on TCP 443.

An uploaded certificate (on the Certificates page) is chosen under Existing certificate on the site's HTTPS tab.

For issuance methods, renewal, TLS, and HTTP/3, see HTTPS and certificates.

6. VerifyCopy Anchor Link

1. Check the Launch check on the site's Overview tab; each item leads to its settings:

   Item	Passes	Otherwise
   DNS pointed N/M	Every domain Points here	Lists the domains that do not; opens the Domains tab
   Certificate	Certificate covers every domain, or No certificate (HTTP only)	Certificate misses domains (listed), Certificate being issued, Certificate issuance failed (with the reason), Certificate expired; opens the HTTPS tab
   Live on N/M nodes	N equals M	Shows the window's end during a canary; with No online nodes, enroll a node first; opens the cluster

2. Send an HTTP request straight to the node, bypassing DNS. Without DNS steering, the Edge addresses card gives a copyable command per domain (HTTPS when the site's certificate covers the domain); otherwise replace 203.0.113.10 below:

   Copy Text

   curl -sI --resolve www.example.com:80:203.0.113.10 http://www.example.com/

   Expected: the status code matches the origin; the response carries an X-Cache header, MISS on the first request for a path covered by a cache rule.

3. Repeat step 2. When the origin response is cacheable, the node answers X-Cache: HIT.

4. With HTTPS enabled:

   Copy Text

   curl -sI --resolve www.example.com:443:203.0.113.10 https://www.example.com/

   Use --resolve for HTTPS, not -H 'Host: …': the node requires SNI to match Host.

5. Once DNS is live:

   Copy Text

   dig +short www.example.com
   curl -sI http://www.example.com/

   Expected: dig returns the node address (preceded by the CNAME target with DNS steering); curl matches step 2.

TroubleshootingCopy Anchor Link