atuin/docs/sync.md
Ellie Huxtable e43e5ce74a
Add logout, only login if not already logged in (#91)
Also:
- Ensures that a key is generated as soon as a user registers!
- Ensures that "atuin key" will generate a key if needed, and doesn't
  double base64 encode data

And a few other little fixes :)

Resolves #85
Resolves #86
2021-05-09 20:11:17 +01:00

1.4 KiB

atuin sync

Atuin can backup your history to a server, and use this to ensure multiple machines have the same shell history. This is all encrypted end-to-end, so the server operator can never see your data!

Anyone can host a server (try atuin server start, more docs to follow), but I host one at https://api.atuin.sh. This is the default server address, which can be changed in the config. Again, I cannot see your data, and do not want to.

Sync frequency

Syncing will happen automatically, unless configured otherwise. The sync frequency is configurable in config

Sync

You can manually trigger a sync with atuin sync

Register

Register for a sync account with

atuin register -u <USERNAME> -e <EMAIL> -p <PASSWORD>

Usernames must be unique, and emails shall only be used for important notifications (security breaches, changes to service, etc).

Upon success, you are also logged in :) Syncing should happen automatically from here!

Key

As all your data is encrypted, Atuin generates a key for you. It's stored in the Atuin data directory (~/.local/share/atuin on Linux).

You can also get this with

atuin key

Never share this with anyone!

Login

If you want to login to a new machine, you will require your encryption key (atuin key).

atuin login -u <USERNAME> -p <PASSWORD> -k <KEY>

Logout

atuin logout