Resequence install steps so the admin UI opens before operator-name and BTCPay
This commit is contained in:
Keysat
+20
-20
@@ -78,11 +78,24 @@
|
||||
|
||||
<p>BTCPay Server is declared as a required dependency. If you don’t have it installed yet, StartOS will prompt you to install it as part of the same flow.</p>
|
||||
|
||||
<h2 id="operator-name">Step 2: Set your operator name</h2>
|
||||
<p>Open the admin web UI (Step 5) and go to <strong>Settings</strong>. Set your operator name there: a short label that identifies <em>you</em> as the seller, e.g. "aurora-software", "northpath", "my-name". This shows up on the public purchase pages and in the audit log.</p>
|
||||
<h2 id="admin-key">Step 2: Get your admin API key</h2>
|
||||
<p>On Keysat’s StartOS service page, go to <strong>Actions → Show credentials</strong>. This reveals the 64-hex-character admin API key that gates all <code>/v1/admin/*</code> endpoints, including the admin UI.</p>
|
||||
|
||||
<div class="callout warn">
|
||||
<i data-lucide="alert-triangle"></i>
|
||||
<p><strong>Treat this key like a password.</strong> Anyone with it can issue, revoke, or read every license you’ve ever sold. Don’t paste it into Slack. Don’t check it into Git.</p>
|
||||
</div>
|
||||
|
||||
<h2 id="admin-ui">Step 3: Open the admin UI</h2>
|
||||
<p>Click the <strong>Launch UI</strong> button on Keysat’s service page. (StartOS surfaces this for any service that defines a <code>type: 'ui'</code> interface.) Paste the admin key from the previous step into the sign-in form.</p>
|
||||
|
||||
<p>From here on, you work in the admin UI. The StartOS Actions tab is reserved for the few operations that must happen outside the web UI: showing credentials, setting the web UI password, and activating or checking the Keysat self-license.</p>
|
||||
|
||||
<h2 id="operator-name">Step 4: Set your operator name</h2>
|
||||
<p>In the admin UI, go to <strong>Settings</strong>. Set your operator name there: a short label that identifies <em>you</em> as the seller, e.g. "aurora-software", "northpath", "my-name". This shows up on the public purchase pages and in the audit log.</p>
|
||||
<p>This change is live-reloaded; you don’t need to restart the service.</p>
|
||||
|
||||
<h2 id="connect-btcpay">Step 3: Connect BTCPay</h2>
|
||||
<h2 id="connect-btcpay">Step 5: Connect BTCPay</h2>
|
||||
<p>Make sure BTCPay Server is running and has at least one <strong>store</strong> with a configured <strong>payment method</strong> (on-chain wallet or Lightning node). Without a payment method, BTCPay will reject Keysat’s invoice creation.</p>
|
||||
|
||||
<p>In the admin web UI, go to <strong>Settings → Payment providers</strong> and click <strong>Connect BTCPay</strong> (agents can drive the same connect over the API with <code>POST /v1/admin/btcpay/connect</code>). You’ll be redirected to BTCPay’s authorize page, where you grant Keysat the permissions it needs:</p>
|
||||
@@ -119,19 +132,6 @@ payment_methods: <span class="s">[BTC-OnChain, BTC-LightningNetwork]</span></pre
|
||||
|
||||
<p>If <code>payment_methods</code> is empty, head back to BTCPay and configure at least one before continuing.</p>
|
||||
|
||||
<h2 id="admin-key">Step 4: Get your admin API key</h2>
|
||||
<p>Go to <strong>Actions → Show credentials</strong>. This reveals the 64-hex-character admin API key that gates all <code>/v1/admin/*</code> endpoints, including the admin UI.</p>
|
||||
|
||||
<div class="callout warn">
|
||||
<i data-lucide="alert-triangle"></i>
|
||||
<p><strong>Treat this key like a password.</strong> Anyone with it can issue, revoke, or read every license you’ve ever sold. Don’t paste it into Slack. Don’t check it into Git.</p>
|
||||
</div>
|
||||
|
||||
<h2 id="admin-ui">Step 5: Open the admin UI</h2>
|
||||
<p>Click the <strong>Launch UI</strong> button on Keysat’s service page. (StartOS surfaces this for any service that defines a <code>type: 'ui'</code> interface.) Paste the admin key from the previous step into the sign-in form.</p>
|
||||
|
||||
<p>From here on, you work in the admin UI. The StartOS Actions tab is reserved for the few operations that must happen outside the web UI: showing credentials, setting the web UI password, and activating or checking the Keysat self-license.</p>
|
||||
|
||||
<h2 id="first-product">Step 6: Define your first product</h2>
|
||||
<p>In the admin UI, go to <strong>Products → Create a new product</strong> and fill in:</p>
|
||||
|
||||
@@ -185,10 +185,10 @@ payment_methods: <span class="s">[BTC-OnChain, BTC-LightningNetwork]</span></pre
|
||||
<div class="label">On this page</div>
|
||||
<a href="#prereq">Prerequisites</a>
|
||||
<a href="#install">1. Install Keysat</a>
|
||||
<a href="#operator-name">2. Set operator name</a>
|
||||
<a href="#connect-btcpay">3. Connect BTCPay</a>
|
||||
<a href="#admin-key">4. Get admin key</a>
|
||||
<a href="#admin-ui">5. Open the admin UI</a>
|
||||
<a href="#admin-key">2. Get admin key</a>
|
||||
<a href="#admin-ui">3. Open the admin UI</a>
|
||||
<a href="#operator-name">4. Set operator name</a>
|
||||
<a href="#connect-btcpay">5. Connect BTCPay</a>
|
||||
<a href="#first-product">6. First product</a>
|
||||
<a href="#first-policy">7. Default policy</a>
|
||||
<a href="#purchase-url">8. Purchase URL</a>
|
||||
|
||||
Reference in New Issue
Block a user