Support & Knowledge Base

FAQs

Still have questions? We have answers! Check out our Frequently Asked Questions for everything you need on SpiderOak

How do I set up a new user from the commandline (bootstrap)

Please note that our method of installation on the command line has changed. These new steps are the best way to do it as of early 2012. You must use a client version 9917 or newer. The --bootstrap method is deprecated, and is replaced by --setup.

Using the setup command line parameter

In order to set up a new user from the commandline, you first need to signup. After you create an account, setup is easy.

Run SpiderOak with the --setup argument. The easiest way to do this is probably like SpiderOak --setup=- which tells SpiderOak to setup using standard input instead of a JSON file for setup parameters.

Upon running SpiderOak with the above option, you will be prompted for your username and password chosen during signup. It will attempt to get a list of devices (for existing accounts), or prompt you for a new device name.

This process should look like the following on the command line:

 johndoe@jupiter:~$ SpiderOak --setup=-
Login: SOExample
Password: 
Logging in...
Getting list of devices...
Please enter a name for the new device: jupiter
Setting up new device...
Finalizing device setup...
Password hint (optional): This is my new hint!
Generating encryption keys (this could take a while)...
Synchronizing with server (this could take a while)...
batchmode run complete: shutting down

At this point, spideroak should be setup for use on this machine as normal!

If you are adding a new device to an existing account, or reinstalling an existing device, the setup prompts will reflect so:

johndoe@jupiter:~$ SpiderOak --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...
Password hint (optional): Secret hint.
Generating encryption keys (this could take a while)...
Synchronizing with server (this could take a while)...
batchmode run complete: shutting down

Setup supports using an external json file for automation. The format of the file is as follows:

 
{
    "username": "username",
    "password": "password",
    "reinstall": true | false,
    "device_name": "device name",
    "password_hint": "hint"
}

* username can be either a username or an email address (but the parameter name is always "username".

* reinstall can be omitted, and defaults to false (ie. set 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.

* password_hint is optional and is only used when setting up the first device.

Note for Windows users: Because of the way Windows programs that have a graphical interface work, we are currently unable to read input at the prompts during setup. We are pursuing a fix for this limitation, but in the meantime, Windows users will have to create the above file by hand to enter the password and hint information.


Using the bootstrap command line parameter

THIS IS THE OLD METHOD, AND IS DEPRECATED. KEEPING FOR REFERENCE.

In order to set up a new user from the commandline, you first need to use the setup form. Fill in the information, then answer the captcha, and a file will be downloaded with the information you entered, plus a special token authorizing the command line setup.

Within TEN minutes (the expiry interval of the authorization token), run SpiderOak with the --bootstrap= command line option, with the path to the file downloaded from the first step as the parameter. See the instructions on running SpiderOak from the command line faq item if you need help with this. If the token expires before completing this step, you may fill out the setup form again to get a new token.

Upon running SpiderOak with the above option, you will be prompted for a password, just as you would during normal new user setup. SpiderOak prompts you for a password at this stage, rather than on the setup form to maintain zero-knowledge privacy. Once you enter a password and an optional hint, SpiderOak will begin generating your encryption keys and uploading your account information to the SpiderOak servers. Once this process completes, SpiderOak is set up, and you may use it just as if you had set up the user normally.

This process should look like the following on the command line:

user@yourmachine:~$ SpiderOak --bootstrap=newusersetup.js Password: (text will not echo) Password (again): (text will not echo) Password hint (optional): A password hint Generating account keys (this could take a while) Done batchmode run complete: shutting down

At this point, spideroak should be setup for use on this machine as normal. Keep in mind please that this process must be completed within 10 minutes of downloading the newusersetup.js

If you are adding a new device to an existing account, your newusersetup.js should look something similar to the following (with a different token, of course ). You will need to edit your account password into the indicated field (replacing ENTER YOUR PASSWORD HERE).

 
{"username": "youruser", "token": "bb15aea5f0691ef6bcdec50cff7fee1ddf53363412745
16245.37", "password": "ENTER YOUR PASSWORD HERE", "device_name": "newdevicename
"}

After preparing the newusersetup.js similarly to the example above, you can then run the spideroak client to bootstrap, which should produce output like this:

user@yourmachine:~$ SpiderOak --bootstrap=newusersetup.js Setting up new device. Done batchmode run complete: shutting down

At this point, spideroak should be setup for use on this machine as normal. Keep in mind please that this process must be completed within 10 minutes of downloading the newusersetup.js from our servers.

Note for Windows users: Because of the way Windows programs that have a graphical interface work, we are currently unable to prompt for a password during this process. We are pursuing a fix for this limitation, but in the meantime, Windows users will have to modify the downloaded file by hand to enter the password and hint information.

To do this, open the downloaded file in a text editor such as Notepad, and just after the { opening brace, add "password": "", "hint": "", and save. Then run the command as in the second step above. SpiderOak will go straight to the key generation phase at this point, without prompting for a password. If you do not wish to add a password hint, you may leave the part empty (but keep the quotes).

To add a device to an existing account: use the new device setup form, then edit the resulting file in a text editor (as directed in the previous paragraph), replacing the text "ENTER YOUR PASSWORD HERE" with your account password, before using the --bootstrap option.


If you are adding a new device to an existing account, your newusersetup.js should look something similar to the following (with a different token, of course ). You will need to edit your account password into the indicated field (replacing ENTER YOUR PASSWORD HERE).


 
{"username": "youruser", "token": "bb15aea5f0691ef6bcdec50cff7fee1ddf53363412745
16245.37", "password": "ENTER YOUR PASSWORD HERE", "device_name": "newdevicename
"}

After preparing the newusersetup.js similarly to the example above, you can then run the spideroak client to bootstrap, which should produce output like this:

 
user@yourmachine:~$ SpiderOak --bootstrap=newusersetup.js
Setting up new device.
Done
batchmode run complete: shutting down

At this point, spideroak should be setup for use on this machine as normal. Keep in mind please that this process must be completed within 10 minutes of downloading the newusersetup.js from our servers.

Couldn't find an answer to your question? Email our support with your question.

Have a Question?