diff options
| author | Ellie Huxtable <ellie@elliehuxtable.com> | 2023-02-25 23:29:59 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-02-25 23:29:59 +0000 |
| commit | c558da5bebfebf239dde867f36cc35d56849accf (patch) | |
| tree | 2e75e2c479fa1d89632eafd8119e084243bafa5e /docs/sync.md | |
| parent | Revert "Remove shortcut numbers (#708)" (#724) (diff) | |
| download | atuin-c558da5bebfebf239dde867f36cc35d56849accf.zip | |
Add fancy web docs (#725)
* Add initial site
* WIP again
* Replace docs with web docs
* Bring back translations
* Update README.md
* remove images
Diffstat (limited to 'docs/sync.md')
| -rw-r--r-- | docs/sync.md | 61 |
1 files changed, 0 insertions, 61 deletions
diff --git a/docs/sync.md b/docs/sync.md deleted file mode 100644 index 7655ed15..00000000 --- a/docs/sync.md +++ /dev/null @@ -1,61 +0,0 @@ -# `atuin sync` - -Atuin can back up 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](config.md). 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](config.md) - -## 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 log in to a new machine, you will require your encryption key -(`atuin key`). - -``` -atuin login -u <USERNAME> -p <PASSWORD> -k <KEY> -``` - -## Logout - -``` -atuin logout -``` |