docker-based installers for all projects
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
conf/reference
data
install
.env
.gitignore
README.md
docker-compose.yml
install-libs.sh
install.bat
install.sh
xel-computation-wallet-build.bat
xel-computation-wallet-start.bat
xel-computation-wallet-stop.bat
xel-computation-wallet.sh
xel-explorer-build.bat
xel-explorer-start.bat
xel-explorer-stop.bat
xel-explorer.sh
xel-lite-wallet-build.bat
xel-lite-wallet-start.bat
xel-lite-wallet-stop.bat
xel-lite-wallet.sh fix nginx config for the first execution Oct 20, 2018
xel-miner-build.bat
xel-miner-start.bat
xel-miner.sh
xel-update-certificates.sh

README.md

xel installer

this project provides easy to use docker-based installers for all xel projects

Disclaimer

Unless required by applicable law or agreed to in writing, we provide the work (and each contributor provides its contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE.

In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any contributor be liable to you for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, loss of coins, computer failure or malfunction, or any and all other commercial damages or losses), even if such contributor has been advised of the possibility of such damages.

BOTH, THE LEGACY-CLIENT AND THE NEW COMPUTATION-ENABLED CLIENT ARE OPEN-SOURCE SOFTWARE RUNNING ON THE MAIN-NET BUT ARE STILL CONSIDERED "BETA" AND MAY CONTAIN BUGS, SOME OF WHICH MAY HAVE SERIOUS CONSEQUENCES.


recommendations

it's recommended to install on a fresh server/desktop. it can run perfectly on an already configured server, just be careful and aware of what the installer does


install pre-requisities

- ubuntu/debian/raspberry/centos

run the installer :

wget https://raw.githubusercontent.com/xel-software/xel-installer-docker/master/install.sh -qO install.sh && bash install.sh

It will install docker and this git project.

- macOS/windows

  • install docker.
  • option 1 : install git then clone this repository : git clone https://github.com/xel-software/xel-installer-docker
  • option 2 : download this project then extract it

update the installer

cd xel-installer-docker
git pull

configuration

elastic configuration

  • go to the project directory : cd xel-installer-docker
  • defaults parameters are in conf/reference/vars.env (do not edit this file)
  • create and edit conf/vars.local.env and add any parameter present in conf/reference/vars.env with your own value

limited set of config supported for now, it will change if needed.

ports configuration

  • defaults ports for the wallet can't be changed
  • defaults ports for the explorers can be changed in .env

running components

- Lite wallet (working)

you start it, display the logs and then stop it :

$ bash xel-lite-wallet.sh start
$ bash xel-lite-wallet.sh logs

then go to http://127.0.0.1:17876

use a custom domain :

you can configure a custom domain to access your wallet :

$ bash xel-lite-wallet.sh domain-add mywallet.mydomain.com

that's it ! your wallet is now accessible at the address https://mywallet.mydomain.com

Known limitations :

  • auto-renewal not supported for now

- Computation wallet (working)

you start it, display the logs and then stop it :

$ bash xel-computation-wallet.sh start
$ bash xel-computation-wallet.sh logs

then go to http://127.0.0.1:17876

use a custom domain :

you can configure a custom domain to access your wallet :

$ bash xel-computation-wallet.sh domain-add mywallet.mydomain.com

that's it ! your wallet is now accessible at the address https://mywallet.mydomain.com

Known limitations :

  • auto-renewal not supported for now

- Miner (working)

you start it :

$ bash xel-miner.sh start

Known limitations :

  • working only with the computation wallet (>3.2).
  • change the number of threads and wallet passphrase in conf/vars.local.env
  • if you don't want to run a local wallet, set miner_use_local_node=false in conf/vars.local.env

- Block Explorer (working)

you start it, display the logs and then stop it :

$ bash xel-explorer.sh start
$ bash xel-explorer.sh logs

then go to http://127.0.0.1

use a custom domain :

you can configure a custom domain to access your explorer :

$ bash xel-explorer.sh domain-add mywallet.mydomain.com

that's it ! your wallet is now accessible at the address https://mywallet.mydomain.com

Known limitations :

  • auto-renewal not supported for now

contribute

PR and issues are open !

Join us on discord for more : https://discord.gg/e4m87M8


support this project

if you like this project and want to support it, donations are welcome !

BTC : 37vHrunarPLRNZAYySaKVvtfpNaQLqz7KY

XEL : XEL-JCN8-AYJE-V2FM-CKY7L