Quickstart signup
You need to download the bitmaelum-suite packages, which should contain at least the bm-client and bm-config apps. Alternatively, you can compile the suite yourself as well through the source code.
You can download the software through GitHub at our release page.
You can also install it directly with either homebrew (mac, linux) or scoop (windows):
$ brew tap bitmaelum/tap
$ brew install bitmaelum-suite
$ scoop bucket add bitmaelum https://github.com/bitmaelum/scoop
$ scoop install bitmaelum-suite
You need to ask a bitmaelum server for an invitation to register an account. If you use your own mail-server, or know somebody with a mail-server, you can ask an invitation from them. Fortunately, there are free mail servers where you can register:
On most of these servers, you need to enter your wanted bitmaelum address, and you will receive a (long) invitation token.
You need to set up your system. This is basically generating a configuration file and a vault.
bm-client config init
This will generate a bitmealum-client-config.yml file. You can manually edit this file but often it's not needed. Next, we initialize the vault:
bm-client vault init
This will generate a new vault which hosts all your (future) accounts. It is an password protected store so during creation, it will ask a password.
Note: without the password, you cannot enter your vault and your accounts are lost.
Next, we can create your account. For this you will need the invitation token and your BitMaelum address.
bm-client account create \
--name "Your name" \
--account '<your bitmaelum address!' \
--token <your token>
Make sure you use the correct information. The address MUST be the same as the address you used for getting the invitation token. BitMaelum will now generate your account locally, create the account on the BitMaelum server, and announce your mail address to the world. From this point on, you can send and receive mail on your new account.
In order to check if everything is ok, you can send an email to our automated hello! responder. This system will send back an automated message to the sender and can be used to quickly check if things work as intended.
bm-client message compose --from 'yourname!' --to 'hello!' --subject "My first bitmaelum mail"
Now you can read back messages:
bm-client message read --account 'yourname!'
If everything went according to plan, you should have received a message from the auto responder.
