Run with Docker
Please ensure that Docker is installed on your Linux server.
1. Download docker image
2. Download and configure the environment variables (.env)
Please create a directory (e.g., $HOME/.exsat/
) to store the files for running the exSat Client via Docker. We will download the .env
file directly from GitHub into this directory.
In the .env
file, most configurations can be customized as needed, you can check here to see the details.
Typically, if this is your first time running the exSat Client and you'reinitializing the account and configuring the Client, there's no need to modify the .env
file.
However, if you have already have the account and keystore, and wish to run the exSat Client directly, you will need to configure the following items,
3. Initialize the account and configure the Client
Start Docker in interactive modeοΌ
Perform below actions in the docker.
3.1 Initiate the synchronizer account
Create or import the account
If you don't have a synchronizer account, please create a new account.
If you already have a synchronizer account, and wish to import it to your client, please import seed phase or import private key.
Register account as synchronizer
If you didn't register your account as synchronizer, please register as synchronizer.
Set Reward Address
If you didn't set reward address for your synchronizer account, please set reward address.
3.2 Configurations
You can complete some client configurations or perform operations on your account:
Set BTC RPC Node (must)
Bridge BTC for gas fee (optional)
Purchase additional memory slot (optional)
Export private key (optional)
Remove your account (optional)
New version check (optional)
4. Execute the Client
Please ensure that you have initialized the synchronizer account and configured the BTC RPC Node.
There are several ways to start the client using Docker, differing in how the keystore password is provided. Choose the method you prefer.
Assuming the keystore file is stored at $HOME/.exsat/synctest_keystore.json
and the password is 123456
, the keystore file path in ".env" file should be look like:
Password stored in ".env"
Please configure password in the .env
file:
Then, start the Docker container with the following command:
Input password in the command
Start docker container with the password as parameter in the command:
Interactive Password Input
Start Docker in interactive mode and enter the password in the command line interface.
Different startup methods vary in terms of security and convenience. If you start the client interactively and enter the password in the interface, the password won't be stored in plain text in the startup command or files, reducing the risk of exposure. However, if you provide the password in the
.env
file or directly in the command line, it may be more prone to leakage but offers greater convenience during startup.
5. Check and claim rewards
You could check and claim rewards on the front-page with the reward address.
Last updated