Step 1: Register and obtain a Credential security Token
Go to slapos.org (or any other SlapOS Master), register if not already done, go to My Account and click on Generate a Credential Secuity Token:
SlapOS client is a set of tools allowing you to manage your SlapOS Nodes, your instances and your SlapOS Master account. It is bundled with the standard SlapOS Node installation.
It will allow you to request and manage your instances, to install Software Release on your nodes, as if you were on slapos.org, but with all the power of terminal.
To follow this tutorial, you will need a server with a GNU/Linux distribution, slapos-node package installed and slapos.org account.
Go to slapos.org (or any other SlapOS Master), register if not already done, go to My Account and click on Generate a Credential Secuity Token:
Run slapos command below, to create the configuration files, when asked please input the Token Saved on Step above.
This command will generate the following files:
You can now, Edit $HOME/.slapos/slapos-client.cfg to include some aliases:
alias =
webrunner https://lab.nexedi.com/nexedi/slapos/raw/1.0.49/software/slaprunner/software.cfg
In order to check if certificate is okay (good location, rights, content...), you can run those commands:
To check validity of certificate:
$ /opt/slapos/parts/openssl/bin/openssl x509 -noout -in $HOME/.slapos/client.crt
To check the key:
$ /opt/slapos/parts/openssl/bin/openssl rsa -noout -in $HOME/.slapos/client.key -check
If you see no output or if command states it's okay, well, everything is okay.
Request installation of a software on a node:
Remove a software from a node:
Request a new or existing instance of wordpress named "mywordpress":
You can't, as of yet, destroy an instance through the command-line.
Open the SlapOS console:
slapconsole is for quite advanced usages. It is basically a Python prompt with all slap modules injected and ready to be used.
We will learn here how to use slapconsole.
Official doc available here.