This article refers to SpiderOak Groups or Enterprise backup. If you are seeking command line help for SpiderOak One backup, see the One command line articles instead.
These instructions presume that your SpiderOak Groups or Enterprise administrator has already added the user that will use the device being set up. A user cannot be created while seated at an endpoint computer, but once the user has been created, you can set up a new device for him or her while seated at the endpoint.
To create or reinstall a device, run SpiderOak Groups with the --setup
option. The easiest way to do this is SpiderOakGroups --setup=-
(notice the trailing dash) which tells it to create a new device by prompting you interactively for setup parameters.
The exact command you will give depends upon your operating system:
- Windows:
""C:\Program Files\SpiderOakGroups\SpiderOakGroups.exe" --setup=-"
Notice the nested quote marks. - Mac:
/Applications/SpiderOakGroups.app/Contents/MacOS/SpiderOakGroups --setup=-
- Linux:
SpiderOakGroups --setup=-
When run this way, the process looks like this:
johndoe@jupiter:~$ SpiderOakGroups --setup=- Login: SOExample Password: Logging in... Getting list of devices... id name 1 jupiter To reinstall a device, enter the id (leave blank to set up a new device): 1 Reinstalling device... Finalizing device setup... Generating encryption keys (this could take a while)... Synchronizing with server (this could take a while)... batchmode run complete: shutting down
--setup also supports using an external JSON file. This method is available on all supported operating systems (Windows, Mac, and Linux) and is particularly suitable for automation and replication. The format of the file is as follows:
{ "username": "username", "password": "password", "reinstall": true | false, "device_name": "device name" }
username
can be a username, an email address, or whatever your organization has chosen to use, but the parameter name in the JSON file is always username
.
reinstall
can be omitted. When it is, it defaults to false (that is, sets up a new device). If reinstall is true, then device_name
is the name of an existing device to reinstall; otherwise device_name
is the name of the new device to set up.
After you have set up a device, your next step is usually to add one or more directories to its backup selection with --backup-dir
.
If you have any feedback on this article please let our support team know. Thanks!