pithos.sia docs: public links at navigate.st/sia
Share… now makes a link anyone can open, so the docs say what it exposes (only that file, decrypted on navigate.st to stream it), how to switch it off, and that it needs no public s3d address.
This commit is contained in:
Local Dev
parent
3ad1cd4823
commit
a56c0182d2
2 changed files with 8 additions and 6 deletions
|
|
@ -90,7 +90,7 @@
|
|||
<h3 id="users-keys"><a class="anchor" href="#users-keys" aria-hidden="true">#</a>Users & keys</h3>
|
||||
<ul><li>Create a user (and its drive, named after it), delete a user.</li><li>Create and revoke access keys. Each key shows ready-made settings for the AWS CLI, rclone and environment variables.</li><li><strong>Save to encrypted file</strong> / <strong>Open saved credentials</strong>: keep keys in a password-protected <code>.pithoskey</code> file (in Theseus it can be sealed with your vault instead).</li></ul>
|
||||
<h3 id="drives"><a class="anchor" href="#drives" aria-hidden="true">#</a>Drives</h3>
|
||||
<ul><li><strong>Views</strong>: Icons (with picture previews), List, Details. Each page remembers its view.</li><li><strong>Upload</strong>: drag files in or use Upload. Single uploads up to 5 GiB (1 GiB from the sidebar).</li><li><strong>New folder</strong>, <strong>Rename…</strong> (files, folders and whole drives; a rename is an instant server-side copy, nothing is uploaded again), <strong>Delete</strong>.</li><li><strong>Viewer</strong>: pictures, video and text open in place; music plays in the player at the bottom, which keeps playing while you browse and moves on through the folder (volume, seek, media keys).</li><li><strong>Share link…</strong>: a signed link valid for 1 hour to 7 days. It opens only where s3d is reachable, so on a default setup only on this computer.</li><li><strong>Access…</strong>: private, public read, or public read + list, for the <strong>whole drive</strong> (s3d cannot make a single folder public). Change it any time.</li><li><strong>Free space</strong> line under the account name.</li></ul>
|
||||
<ul><li><strong>Views</strong>: Icons (with picture previews), List, Details. Each page remembers its view.</li><li><strong>Upload</strong>: drag files in or use Upload. Single uploads up to 5 GiB (1 GiB from the sidebar).</li><li><strong>New folder</strong>, <strong>Rename…</strong> (files, folders and whole drives; a rename is an instant server-side copy, nothing is uploaded again), <strong>Delete</strong>.</li><li><strong>Viewer</strong>: pictures, video and text open in place; music plays in the player at the bottom, which keeps playing while you browse and moves on through the folder (volume, seek, media keys).</li><li><strong>Share…</strong>: a <strong>public link</strong> at <code>https://navigate.st/sia/<id>/<name></code> that anyone can open on any device, even with this computer off, for 1 month, 1 year or 5 years. On a folder, ⋯ › Public link… makes a page with the files in it (not sub-folders). Files still waiting on this computer are uploaded to Sia first. Settings › Public links lists them; Switch off stops a link at once. Under "Link for this computer, or your own server" is the old signed s3d link (1 hour to 7 days), which opens only where s3d is reachable.</li><li><strong>Access…</strong>: private, public read, or public read + list, for the <strong>whole drive</strong> (s3d cannot make a single folder public). Change it any time.</li><li><strong>Free space</strong> line under the account name.</li></ul>
|
||||
<h3 id="settings"><a class="anchor" href="#settings" aria-hidden="true">#</a>Settings</h3>
|
||||
<p>Edits <code>s3d.yml</code>; s3d reads it at start, so restart to apply. Also: automatic upload of leftovers (on by default, after 10 minutes with no new uploads) and where your drives live.</p>
|
||||
<h3 id="logs"><a class="anchor" href="#logs" aria-hidden="true">#</a>Logs</h3>
|
||||
|
|
@ -175,11 +175,11 @@ force_path_style = true</code></pre>
|
|||
rclone copy ./photos s3d:my-drive/photos --progress</code></pre>
|
||||
<p><strong>Environment variables</strong> for SDKs and tools: <code>AWS_ACCESS_KEY_ID</code>, <code>AWS_SECRET_ACCESS_KEY</code>, <code>AWS_DEFAULT_REGION=us-east-1</code>, <code>AWS_ENDPOINT_URL=http://127.0.0.1:8000</code>.</p>
|
||||
<h2 id="common-tasks"><a class="anchor" href="#common-tasks" aria-hidden="true">#</a>Common tasks</h2>
|
||||
<ul><li><strong>Give an app its own key.</strong> Users & keys › create a user for the app (or use yours) › Create key. Revoke it later without touching your other keys.</li><li><strong>Make files public.</strong> Keep them in a drive of their own and set Access › Public read. Files are then at <code>http://<s3d address>/<drive>/<path></code>. On a default setup that address is reachable only from this computer; for other people s3d needs a public address (for example behind your own server and a TLS proxy).</li><li><strong>Rename or move.</strong> ⋯ › Rename… on a file, folder or drive. Renaming a drive changes its name for S3 apps too.</li><li><strong>Back up.</strong> Keep the recovery phrase offline (or use the vault-derived phrase and back up the Theseus vault). Optionally <code>POST /snapshots</code> to keep a copy of s3d's database on Sia.</li><li><strong>Move to another computer.</strong> Install s3d, run <code>s3d login</code> with the same indexer login and the same phrase, then restore the database snapshot or recreate users and keys.</li></ul>
|
||||
<ul><li><strong>Give an app its own key.</strong> Users & keys › create a user for the app (or use yours) › Create key. Revoke it later without touching your other keys.</li><li><strong>Share one file or folder with anyone.</strong> ⋯ › Share… › Create public link. The link reads only that file from your Sia account; nothing else in the account is exposed.</li><li><strong>Make a whole drive public.</strong> Keep the files in a drive of their own and set Access › Public read. Files are then at <code>http://<s3d address>/<drive>/<path></code>. On a default setup that address is reachable only from this computer; for other people s3d needs a public address (for example behind your own server and a TLS proxy).</li><li><strong>Rename or move.</strong> ⋯ › Rename… on a file, folder or drive. Renaming a drive changes its name for S3 apps too.</li><li><strong>Back up.</strong> Keep the recovery phrase offline (or use the vault-derived phrase and back up the Theseus vault). Optionally <code>POST /snapshots</code> to keep a copy of s3d's database on Sia.</li><li><strong>Move to another computer.</strong> Install s3d, run <code>s3d login</code> with the same indexer login and the same phrase, then restore the database snapshot or recreate users and keys.</li></ul>
|
||||
<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>Folder-level sharing and rights for other people need drives on Silent Mode (see that section); a plain s3d cannot do them.</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>Signed s3d links and public drives reach other people only when s3d has a public address; navigate.st/sia public links do not need one.</li><li>navigate.st/sia links have a daily download cap per link, and anyone with the link can read the file: it is decrypted on navigate.st to stream it.</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>
|
||||
|
|
|
|||
|
|
@ -70,7 +70,7 @@ The menu is in setup order. In the narrow sidebar it is the ☰ button at the to
|
|||
- **Upload**: drag files in or use Upload. Single uploads up to 5 GiB (1 GiB from the sidebar).
|
||||
- **New folder**, **Rename…** (files, folders and whole drives; a rename is an instant server-side copy, nothing is uploaded again), **Delete**.
|
||||
- **Viewer**: pictures, video and text open in place; music plays in the player at the bottom, which keeps playing while you browse and moves on through the folder (volume, seek, media keys).
|
||||
- **Share link…**: a signed link valid for 1 hour to 7 days. It opens only where s3d is reachable, so on a default setup only on this computer.
|
||||
- **Share…**: a **public link** at `https://navigate.st/sia/<id>/<name>` that anyone can open on any device, even with this computer off, for 1 month, 1 year or 5 years. On a folder, ⋯ › Public link… makes a page with the files in it (not sub-folders). Files still waiting on this computer are uploaded to Sia first. Settings › Public links lists them; Switch off stops a link at once. Under "Link for this computer, or your own server" is the old signed s3d link (1 hour to 7 days), which opens only where s3d is reachable.
|
||||
- **Access…**: private, public read, or public read + list, for the **whole drive** (s3d cannot make a single folder public). Change it any time.
|
||||
- **Free space** line under the account name.
|
||||
|
||||
|
|
@ -253,7 +253,8 @@ rclone copy ./photos s3d:my-drive/photos --progress
|
|||
## Common tasks
|
||||
|
||||
- **Give an app its own key.** Users & keys › create a user for the app (or use yours) › Create key. Revoke it later without touching your other keys.
|
||||
- **Make files public.** Keep them in a drive of their own and set Access › Public read. Files are then at `http://<s3d address>/<drive>/<path>`. On a default setup that address is reachable only from this computer; for other people s3d needs a public address (for example behind your own server and a TLS proxy).
|
||||
- **Share one file or folder with anyone.** ⋯ › Share… › Create public link. The link reads only that file from your Sia account; nothing else in the account is exposed.
|
||||
- **Make a whole drive public.** Keep the files in a drive of their own and set Access › Public read. Files are then at `http://<s3d address>/<drive>/<path>`. On a default setup that address is reachable only from this computer; for other people s3d needs a public address (for example behind your own server and a TLS proxy).
|
||||
- **Rename or move.** ⋯ › Rename… on a file, folder or drive. Renaming a drive changes its name for S3 apps too.
|
||||
- **Back up.** Keep the recovery phrase offline (or use the vault-derived phrase and back up the Theseus vault). Optionally `POST /snapshots` to keep a copy of s3d's database on Sia.
|
||||
- **Move to another computer.** Install s3d, run `s3d login` with the same indexer login and the same phrase, then restore the database snapshot or recreate users and keys.
|
||||
|
|
@ -275,7 +276,8 @@ 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.
|
||||
- Signed s3d links and public drives reach other people only when s3d has a public address; navigate.st/sia public links do not need one.
|
||||
- navigate.st/sia links have a daily download cap per link, and anyone with the link can read the file: it is decrypted on navigate.st to stream it.
|
||||
- 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