Prerequisites: Create an Azure Storage Account
You need an Azure Storage Account and its access key before running Arius.
- Log in to the Azure Portal.
- Create a Storage Account (any region, LRS redundancy is sufficient for archival).
- Navigate to Security + networking → Access keys and copy one of the two keys.
- Note your storage account name — you’ll need both values in the next steps.
Install Arius via Docker
Docker is the recommended way to run Arius. Pull the latest image from Docker Hub:Verify the image is available:
Set Your Credentials
Export your Azure Storage credentials as environment variables so you don’t have to pass them on every command:
Archive Your First Directory
Run the What happens during archive:
archive command, mounting the directory you want to back up to /archive inside the container:- Files are hashed and deduplicated at the file level.
- Contents are AES256-encrypted using your passphrase before upload.
- Blobs are uploaded to the
archivestorage tier by default (~1 EUR/TB/month). - Small pointer files (
.pointer.arius) are created alongside your local files, keeping your directory structure visible in the filesystem.
| Flag | Description |
|---|---|
--tier=hot|cool|archive | Override the storage tier (default: archive) |
--remove-local | Delete local files after a successful upload |
--dedup | Enable block-level deduplication within files |
--fasthash | Skip re-hashing files that already have a pointer (do not use if file contents may have changed) |
Verify with pointer synchronization
After archiving, run A successful run confirms your local pointer files are in sync with Azure.
restore without --download to confirm that all pointer files on disk match the current state of your remote repository. This does not download any file contents — it only creates or removes local .pointer.arius files to reflect what is in Azure.Files stored in the Archive tier must be rehydrated before they can be downloaded. Rehydration typically takes up to 15 hours. If you run
restore --download and some files are still rehydrating, Arius will report them and you can re-run the command after the rehydration window has passed.Next Steps
Installation
Explore all installation methods including native binaries and Arius Explorer for Windows.
Archive Command
Full reference for all archive options, tiers, deduplication, and encryption settings.
Restore Command
Learn how to synchronize pointers, trigger rehydration, and download files.
Arius Explorer
Browse and manage your Arius repository with the Windows GUI application.