We’re here - the final piece of the Vault Phase 1 milestone!! As we mentioned last week, the final piece of this puzzle was to replace ‘mock’ vault with the real one. So with today’s release, we have the SAFE CLI, ‘real’ SAFE Client Libs and now ‘real’ Vault that you can run on your machine!
We’ve also set up a public shared Vault for you to play with. To access it, you can use the SAFE CLI to configure your machine. Please find more details and instructions below.
What’s included today?
Today we’ve got new versions of the SAFE CLI, the Authenticator daemon and the Vault binary itself.
If you’ve played with previous releases, you’ll need to update them to be able to authenticate against the Vaults - see instructions below.
You can download the new Vault release on GitHub. Builds are available for Windows, macOS and Linux.
How to update your SAFE CLI and Authenticator daemon
Thanks to our recent implementation of the self_update
crate in the SAFE CLI, if you already have a previous version of the SAFE CLI on your machine, to update it you can navigate to the directory that the binary resides in and run it with the update
argument ($ safe update
). You can also use the SAFE CLI to update the Authenticator daemon ($ safe auth update
).
If you don’t already have the SAFE CLI locally, you can download it from its GitHub release page. You can also download safe-authd v0.0.4 from that page. See the Authenticator section in the CLI User Guide for detailed instructions.
How to run a Vault
With the vault downloaded, you can run $ safe_vault
and it will automatically create config files for you locally.
Make sure you’ve followed the instructions here to install and start the Authenticator daemon.
You can now run $ safe auth create-acc --test-coins
to create a local balance. Then run $ safe auth login --self-auth
to log in.
You can now use the SAFE CLI to create websites, for example!
If you want to learn even more about the commands and use cases supported by the SAFE CLI, please refer to the SAFE CLI User Guide, we strongly recommend you to give it a read to be able to make use of all the functionality it provides.
Using the Shared Vault
We decided to host a vault for the community to allow those of you who do not want to run your own vault to still have a go at using the SAFE CLI. Follow the steps below to configure your machine if you want to connect to the Shared Vault.
If you’re using the SAFE CLI, you can use the safe networks add
and safe networks switch
commands. For example:
$ safe networks add shared https://safe-vault-config.s3.eu-west-2.amazonaws.com/shared-vault/vault_connection_info.config
Network 'shared' was added to the list. Connection information is located at 'https://safe-vault-config.s3.eu-west-2.amazonaws.com/shared-vault/vault_connection_info.config'
$ safe networks switch shared
Switching to 'shared' network...
Fetching 'shared' network connection information from 'https://safe-vault-config.s3.eu-west-2.amazonaws.com/shared-vault/vault_connection_info.config' ...
Successfully switched to 'shared' network in your system!
You'll need to login again, and re-authorise the CLI, if you need write access to the 'shared' network
Alternatively, you can:
- Download the
vault_connection_info.config
file from GitHub - Depending of your platform:
- If you are on Linux, save this file to
~/.config/safe_vault/
- If you are on macOS, save this file to
/Users/<USERNAME>/Library/Preferences/net.MaidSafe.safe_vault/
- If you are on Windows, save this file to
C:\Users\<USERNAME>\AppData\Roaming\MaidSafe\safe_vault\config\
- If you are on Linux, save this file to
You will now be able to follow the instructions from the SAFE CLI User Guide and connect your SAFE CLI to the Shared Vault.
Upload timeout - local and shared vault
Right now Client Libs feature a timeout after three minutes, which means larger files on slower connections will not be uploaded successfully. This is a known limitation and will be dealt with down the line. This may be particularly noticeable when uploading over a slow connection to a busy shared vault.
Bonus product
Just like the end of the movie credits there’s often bonus footage … well here we have a bonus product for you - the SAFE Browser proof of concept for these new shiny APIs that form the basis of the CLI. You can download the SAFE Browser over here for Windows, macOS and Linux. And it’s worth noting, this does not work with the alpha-2 network, nor does it feature a baked in authenticator page at the moment.
Feedback and support
As always, you can drop your comments or feedback below this post or, if you prefer, in GitHub in the corresponding repo.
If you need any support, don’t hesitate to pop your question below either and one of the team will happily help you out.