pithos.sia docs: drives on Silent Mode are open, with public folders at navigate.st/s3
The docs said hosting on Silent Mode was not open yet. It is now: a section explains moving s3d to s3.silentmode.st, the encryption, the sharing a plain s3d cannot do, signing up with a BNS name, and public folders at navigate.st/s3/<name>/<drive>/<folder>/.
This commit is contained in:
Local Dev
parent
200faa774a
commit
c7576c726c
2 changed files with 18 additions and 3 deletions
|
|
@ -66,7 +66,7 @@
|
|||
<a class="md" href="pithos-docs.md" title="The same page as plain Markdown, for AI assistants">Markdown ↓</a>
|
||||
</nav>
|
||||
<div class="layout">
|
||||
<nav class="toc" aria-label="On this page"><div class="t">On this page</div><a href="#how-the-pieces-fit">How the pieces fit</a><a href="#getting-started-pithos-in-theseus">Getting started (Pithos in Theseus)</a><a href="#the-pithos-screen">The Pithos screen</a><a href="#other-ways-to-run-pithos">Other ways to run Pithos</a><a href="#s3d-on-the-command-line">s3d on the command line</a><a href="#using-drives-from-other-apps">Using drives from other apps</a><a href="#common-tasks">Common tasks</a><a href="#troubleshooting">Troubleshooting</a><a href="#limits">Limits</a><a href="#for-ai-assistants">For AI assistants</a></nav>
|
||||
<nav class="toc" aria-label="On this page"><div class="t">On this page</div><a href="#how-the-pieces-fit">How the pieces fit</a><a href="#getting-started-pithos-in-theseus">Getting started (Pithos in Theseus)</a><a href="#the-pithos-screen">The Pithos screen</a><a href="#drives-on-silent-mode">Drives on Silent Mode</a><a href="#other-ways-to-run-pithos">Other ways to run Pithos</a><a href="#s3d-on-the-command-line">s3d on the command line</a><a href="#using-drives-from-other-apps">Using drives from other apps</a><a href="#common-tasks">Common tasks</a><a href="#troubleshooting">Troubleshooting</a><a href="#limits">Limits</a><a href="#for-ai-assistants">For AI assistants</a></nav>
|
||||
<article>
|
||||
<h1>Pithos documentation</h1>
|
||||
<div class="agent"><strong>Using an AI assistant?</strong> Give it this page or the <a href="pithos-docs.md">Markdown version</a>, then describe what you want to do. Type recovery phrases and secret keys only into s3d or Pithos on your own computer, never into a chat.</div>
|
||||
|
|
@ -97,6 +97,10 @@
|
|||
<p>Live output of s3d and Pithos's own notes (why it started or did not start s3d, flushes, errors).</p>
|
||||
<h3 id="addresses-updates-and-the-lock"><a class="anchor" href="#addresses-updates-and-the-lock" aria-hidden="true">#</a>Addresses, updates and the lock</h3>
|
||||
<ul><li>In Theseus, the full page lives at <code>pithos.sia/<user>/<drive>/<folder></code> (and <code>pithos.sia/settings</code>, <code>pithos.sia/account</code> …). The bare <code>pithos.sia</code> is this website.</li><li>The footer shows the version. ↻ checks for updates; a newer version shows as "↑ vX". Click it to install; recent Theseus versions apply it without a restart, older ones offer a restart.</li><li>When the vault locks, Pithos locks too; Unlock asks for your PIN.</li></ul>
|
||||
<h2 id="drives-on-silent-mode"><a class="anchor" href="#drives-on-silent-mode" aria-hidden="true">#</a>Drives on Silent Mode</h2>
|
||||
<p>By default s3d runs on your computer. Settings › <strong>Where your drives live</strong> can move it to Silent Mode's server (<code>s3.silentmode.st</code>) instead. It keeps working with your computer off, other devices can reach it, and the Pithos screens stay the same.</p>
|
||||
<ul><li><strong>Still your own Sia account.</strong> Only s3d's data folder (its database and the files still waiting) moves; nothing already on Sia is uploaded again, and the recovery phrase never leaves your computer. Moving back works the same way.</li><li><strong>Encrypted before it leaves.</strong> Pithos encrypts file names and contents on your computer, with keys from your Theseus vault (or a key file beside <code>s3d.yml</code> that you should back up).</li><li><strong>Sharing a plain s3d cannot do.</strong> Public folders, expiring share links, and S3 keys for other people limited to one folder with read, add-only or edit rights. Shared files are stored readable, because the people they are for have no key; stop sharing and Pithos encrypts them again.</li><li><strong>Signing up</strong> needs a signature from the wallet that owns a BNS name: one hosted account per name.</li></ul>
|
||||
<p><strong>Public folders anyone can open.</strong> Make a folder public (⋯ › Share… on a drive on Silent Mode) and it gets an address like <code>https://navigate.st/s3/<your-bns-name>/<drive>/<folder>/</code>: a page with its files, small pictures and a player, which works in any browser. A single file is at the same address plus its name. Tools can add <code>?json</code> to a folder address for a JSON listing.</p>
|
||||
<h2 id="other-ways-to-run-pithos"><a class="anchor" href="#other-ways-to-run-pithos" aria-hidden="true">#</a>Other ways to run Pithos</h2>
|
||||
<h3 id="web-console"><a class="anchor" href="#web-console" aria-hidden="true">#</a>Web console</h3>
|
||||
<pre class="code" data-lang="bash"><button class="copy" type="button" aria-label="Copy">Copy</button><code>npm install
|
||||
|
|
@ -175,7 +179,7 @@ rclone copy ./photos s3d:my-drive/photos --progress</code></pre>
|
|||
<h2 id="troubleshooting"><a class="anchor" href="#troubleshooting" aria-hidden="true">#</a>Troubleshooting</h2>
|
||||
<div class="table"><table><thead><tr><th>What you see</th><th>What it means / what to do</th></tr></thead><tbody><tr><td>"N files waiting to upload", or "0 B on Sia"</td><td>Files are still in the local buffer. Click <strong>Upload now</strong> (or <code>s3d flush</code>); automatic upload does it after 10 quiet minutes.</td></tr><tr><td>s3d "stopped" or "crashed"</td><td>Overview › Start; read Logs for the reason. "Not registered" means <code>s3d login</code> has not been done for this config.</td></tr><tr><td>A link with <code>127.0.0.1</code> does not open elsewhere</td><td>Expected: it points to the computer running s3d.</td></tr><tr><td><code>SignatureDoesNotMatch</code> in an S3 app</td><td>Wrong secret, or the app uses virtual-host style; switch to path-style and region <code>us-east-1</code>.</td></tr><tr><td>"address already in use"</td><td>Another program (or another s3d) uses port 8000/8001; change <code>apiAddress</code>/<code>adminAddress</code> or stop the other one.</td></tr><tr><td>Pithos shows "external"</td><td>Another s3d is already running for this config; Pithos reads its stats but leaves it alone.</td></tr><tr><td>Pithos is locked</td><td>Your Theseus vault is locked; Unlock asks for the PIN.</td></tr><tr><td>A different account than expected</td><td>The account is the indexer login plus the phrase. Accounts › Which Sia account this is shows the account key; compare it on sia.storage under My apps › S3d.</td></tr></tbody></table></div>
|
||||
<h2 id="limits"><a class="anchor" href="#limits" aria-hidden="true">#</a>Limits</h2>
|
||||
<ul><li>Public access is per drive, read-only for others; s3d has no folder-level rules or write rights for other people.</li><li>Single uploads are capped at 5 GiB (multipart uploads from S3 tools work for larger files).</li><li>Share links and public files reach other people only when s3d has a public address.</li><li>Running s3d on Silent Mode's server ("On Silent Mode", with encryption in the browser and folder-level sharing) is built into Pithos but the service is not open yet.</li></ul>
|
||||
<ul><li>Public access is per drive, read-only for others; s3d has no folder-level rules or write rights for other people.</li><li>Single uploads are capped at 5 GiB (multipart uploads from S3 tools work for larger files).</li><li>Share links and public files reach other people only when s3d has a public address.</li><li>Folder-level sharing and rights for other people need drives on Silent Mode (see that section); a plain s3d cannot do them.</li></ul>
|
||||
<h2 id="for-ai-assistants"><a class="anchor" href="#for-ai-assistants" aria-hidden="true">#</a>For AI assistants</h2>
|
||||
<p>You are helping someone run <strong>s3d</strong> (the Sia S3 gateway), optionally through <strong>Pithos</strong>. Facts to rely on:</p>
|
||||
<ul><li>s3d v0.2.0+, S3 API on <code>127.0.0.1:8000</code>, admin API on <code>127.0.0.1:8001</code> (Basic auth, empty user, <code>adminPassword</code>), region <code>us-east-1</code>, path-style addressing.</li><li>Setup order: <code>s3d config</code> → <code>s3d login</code> (indexer URL + 12-word phrase, approve the "S3d" app at the indexer) → run <code>s3d</code> → <code>s3d users create</code> → <code>s3d keys create</code> → use any S3 client.</li><li>Small files wait locally until a ~40 MB block fills; <code>s3d flush</code> or <code>POST /objects/flush</code> uploads them now.</li><li>Buckets ("drives") can be private, public read, or public read + list; nothing finer.</li><li>Config lookup: <code>S3D_CONFIG_FILE</code>, else the OS default path listed above.</li></ul>
|
||||
|
|
|
|||
|
|
@ -88,6 +88,17 @@ Live output of s3d and Pithos's own notes (why it started or did not start s3d,
|
|||
- The footer shows the version. ↻ checks for updates; a newer version shows as "↑ vX". Click it to install; recent Theseus versions apply it without a restart, older ones offer a restart.
|
||||
- When the vault locks, Pithos locks too; Unlock asks for your PIN.
|
||||
|
||||
## Drives on Silent Mode
|
||||
|
||||
By default s3d runs on your computer. Settings › **Where your drives live** can move it to Silent Mode's server (`s3.silentmode.st`) instead. It keeps working with your computer off, other devices can reach it, and the Pithos screens stay the same.
|
||||
|
||||
- **Still your own Sia account.** Only s3d's data folder (its database and the files still waiting) moves; nothing already on Sia is uploaded again, and the recovery phrase never leaves your computer. Moving back works the same way.
|
||||
- **Encrypted before it leaves.** Pithos encrypts file names and contents on your computer, with keys from your Theseus vault (or a key file beside `s3d.yml` that you should back up).
|
||||
- **Sharing a plain s3d cannot do.** Public folders, expiring share links, and S3 keys for other people limited to one folder with read, add-only or edit rights. Shared files are stored readable, because the people they are for have no key; stop sharing and Pithos encrypts them again.
|
||||
- **Signing up** needs a signature from the wallet that owns a BNS name: one hosted account per name.
|
||||
|
||||
**Public folders anyone can open.** Make a folder public (⋯ › Share… on a drive on Silent Mode) and it gets an address like `https://navigate.st/s3/<your-bns-name>/<drive>/<folder>/`: a page with its files, small pictures and a player, which works in any browser. A single file is at the same address plus its name. Tools can add `?json` to a folder address for a JSON listing.
|
||||
|
||||
## Other ways to run Pithos
|
||||
|
||||
### Web console
|
||||
|
|
@ -265,7 +276,7 @@ rclone copy ./photos s3d:my-drive/photos --progress
|
|||
- Public access is per drive, read-only for others; s3d has no folder-level rules or write rights for other people.
|
||||
- Single uploads are capped at 5 GiB (multipart uploads from S3 tools work for larger files).
|
||||
- Share links and public files reach other people only when s3d has a public address.
|
||||
- Running s3d on Silent Mode's server ("On Silent Mode", with encryption in the browser and folder-level sharing) is built into Pithos but the service is not open yet.
|
||||
- Folder-level sharing and rights for other people need drives on Silent Mode (see that section); a plain s3d cannot do them.
|
||||
|
||||
## For AI assistants
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue