dehaze

Manual

This guide will help you set up Space Cloud manually using the space-cloud binary.

Step 1: Download Space Cloud

The first step is to download the space-cloud binary. You need to download binary for your operating system or you could build it directly from its source code. You will need go version 1.12.0 or later to build it from source.

Download the binary for your OS from here:

You can unzip the compressed archive

For Linux / Mac: unzip space-cloud.zip && chmod +x space-cloud

For Windows: Right click on the archive and select extract here.

To make sure if space-cloud binary is correct, type the following command from the directory where space-cloud is downloaded:

For Linux / Mac: ./space-cloud -v

For Windows: space-cloud.exe -v

It should show something like this:

space-cloud-ee version 0.12.0

Step 2: Start Space Cloud

The following command runs space-cloud binary along with setting the admin credentials for Mission Control:

./space-cloud run \
  --admin-user=some-admin \
  --admin-pass=some-pass \
  --admin-secret=some-secret 
space-cloud.exe run \
  --admin-user=some-admin \
  --admin-pass=some-pass \
  --admin-secret=some-secret  

Here, --admin-user and --admin-pass are the credentials to login into Mission Control (Admin UI), whereas --admin-secret is the JWT secret used to authenticate login requests for Mission Control.

Note: The HTTP and grpc endpoints are available in a secure fashion over SSL on ports 4126 and 4128 respectively.

To expose the HTTP and grpc endpoints of Space Cloud in a secure way via SSL run the following command:

./space-cloud run \
  --admin-user=some-admin \
  --admin-pass=some-pass \
  --admin-secret=some-secret \
  --ssl-cert=/path/to/ssl-cert-file \
  --ssl-key=/path/to/ssl-key-file
space-cloud.exe run \
  --admin-user=some-admin \
  --admin-pass=some-pass \
  --admin-secret=some-secret \
  --ssl-cert=/path/to/ssl-cert-file \
  --ssl-key=/path/to/ssl-key-file

You should be seeing something like this when space-cloud starts:

Starting Nats Server
Starting grpc server on port: 4124
2019/08/03 08:00:38 Syncman node query response error: failed to respond to key query: response is past the deadline
Starting http server on port: 4122

	 Hosting mission control on http://localhost:4122/mission-control/

Space cloud is running on the specified ports :D

Step 3: Configure Space Cloud

As you would have noticed, on running space-cloud, a config.yaml file and a raft-store folder would have been generated in the directory from where you had run space-cloud.

Space Cloud needs this config file in order to function. The config file is used to load information like the database to be used, its connection string, security rules, etc.

Space Cloud has it’s own Mission Control (admin UI) to configure all of this in an easy way.

Note: All changes to the config of space-cloud has to be done through the Mission Control only. Changes made manually to the config file will get overwritten.

Open Mission Control

Head over to http://localhost:4122/mission-control or https://localhost:4126/mission-control to open Mission Control depending on how you started space-cloud.

Note: Replace localhost with the address of your Space Cloud if you are not running it locally.

Next Steps

Awesome! We just started Space Cloud manually. Next step would be to set up a project to use Space Cloud in your preffered language.

Feel free to check out various capabalities of space-cloud:

Have a technical question?

Improve the docs!