Getting started
The essentials after creating an account, in the order they matter: keep the credentials safe, prove a round trip works, pick a backup tool, know where you stand, invite someone. Each step is a command or two. No account is needed to read this page; with one, the numbers below are yours.
·Your account
Show your usage, quota and invite link on this page. Paste the OBSIDEO_ACCOUNT_TOKEN line's
value from obsideo-credentials.env. It stays in this browser tab.
Shown from your Obsideo Drive sign-in in this browser. Drive keeps its own encryption key, so it needs none of the files described below. To use an S3 tool such as rclone, restic or boto3 with this same account, verify the same email at /start/: it issues S3 keys for this account and space, and your Drive sign-in keeps working.
01Keep the two files together, and private
Signup gave you two downloads. obsideo-credentials.env holds the endpoint, bucket, access key,
secret key and account token. obsideo-signing.pem is your account signing key; only its public
half was sent to Obsideo. Keep both outside shared folders and code repositories.
02Prove it works: one file out, one file back
With the rclone remote from signup (the [obsideo] stanza in ~/.config/rclone/rclone.conf),
five commands upload a file, download it again and compare the two. Swap in your bucket name where it says
BUCKET; with your account shown above it is filled in already.
On Windows, replace the cmp line with fc check.txt back\check.txt. A 403 on the very
first write within about 30 seconds of signup means the credentials are still propagating: wait a moment and retry.
Anything else, write to regan@obsideo.io with the command and the output.
03Pick the tool that matches the job
Obsideo stores what your tool sends. restic and kopia encrypt on your machine before upload; plain rclone does not, unless you add a crypt remote. Which one is right depends on what you are protecting.
A folder you want mirrored: rclone
One-way copy; re-running only sends what changed. Add --dry-run first if the folder is large.
Backups with history and encryption: restic
Deduplicated snapshots, encrypted with a password that never leaves your machine. Keep the password file safe: without it the repository cannot be read, by you or by anyone.
The same idea with a GUI option: kopia
From code: boto3 or any S3 client
Database dumps, agents, chain-indexer artifacts and other recipes are on the docs page. Software agents can run the whole flow from agents.md.
04Know where you stand
The free tier is 12 GB with no expiry and no card. Past that, storage is $5 per month per 200 GB block, egress included;
upgrading is on the pricing section and never happens without your say-so. Usage is the number
at the top of this page, or obsideo usage from the CLI.
Obsideo is a young network without an availability SLA yet. It suits an additional copy of your data better than the only copy. The live fleet is on the network page; how it works is on security.
05Invite someone
Every account has an invite link. Someone who signs up through it starts with 13 GB instead of 12, and once they have stored their first megabyte you get 2 GB added to your quota. There is no cap on how many times that can happen.
Show your account at the top of the page to see your link here, or run obsideo refer in the CLI.
06Hear about changes, if you want to
The only email you will get by default is the one carrying a verification code, plus a notice if your account is close to its quota. Anything else needs your yes below. Nothing is pre-ticked.
Show your account at the top of the page to set this.
Prefer to follow along without email? The network's changes are posted on Telegram, and the provider software is on GitHub.