::: {.header}

SkySpark by SkyFoundry

:::

::: {.breadcrumb}

- Doc Index
- docSkySpark
- Setup
:::

::: {.mainSidebar}

::: {.main .chapter}

- 2. Deployment

Setup

Overview

SkySpark is distributed as a simple ZIP file. To install it:

Unzip the contents to the host machine
Verify
installation by running \"skyspark -version\"
Run setup
command line program
See
upgrades
for upgrading an older version
See
licensing
for acquiring and installing license keys

Before you begin setup you might want to review

Deployment

chapter.

Verify Setup {#verify}

In general the only setup required is to put \"bin\" into your path. On

Unix you might need to call \"chmod +x\" on the shell scripts.

// Windows
set PATH=%PATH%;c:\skyspark\bin

// Unix
PATH=$PATH:/opt/skyspark/bin
chmod +x /opt/skyspark/bin/*

If you don\'t want to put skyspark/bin into your path, then just make

sure you cd to the bin directory to run skyspark. If everything is

setup correctly you should be able to run \"skyspark -version\":

E:\skyspark\bin>skyspark -version

Copyright (c) 2009-2016, SkyFoundry LLC
All Rights Reserved

skyarc.version: 3.0.4
skyarc.homeDir: E:\skyspark
skyarc.varDir: E:\skyspark\var
java.version: 1.8.0_91
java.vm.name: Java HotSpot(TM) 64-Bit Server VM
java.vm.vendor: Oracle Corporation
java.vm.version: 25.91-b14
java.home: C:\Program Files (x86)\Java\jre8
fan.version: 1.0.68.4
fan.platform: win32-x86

The SkySpark installation is a super-set of a standard Fantom

installation. If you have any trouble, see Fantom

Setup
to troubleshoot your

environment.

Setup {#setup}

Before you can run SkySpark for the first time you will need to run the

\"bin/setup.bat\" batch file or \"bin/setup\" bash script. This command

line tool will configure the following items:

- create a super user account
- HTTP port
- will copy license from older file

Follow the prompts to perform the bootstrap setup. If you are running on

Linux/OS X then make sure to select a port above 1024, otherwise you

will need to run skyspark via sudo.

Running

To run use the \"bin/skyspark.bat\" batch file on Windows or the

\"bin/skyspark\" bash script on Unix and OS X. Summary of options:

- Help: use \"-?\" or \"-help\" to dump the usage
- Version: use \"-version\" to dump version information (useful
for verifying your setup)
- No Auth: use \"-noAuth\" to disable authentication, the su
account for all HTTP requests to the server
- Var: the \"-var <dir>\" option is used to run SkySpark against
an alternate variable directory which is where all your project
databases are located

Assuming you have successfully run the setup command line program and

installed your license, then a successful boot looks like this:

C:\skyspark\bin>skyspark
[2016-06-20 09:06:09] <defs> {} [info] SysDef loaded [941ms]
[2016-06-20 09:06:09] <folio.demo> {} [info] Proj opened
[2016-06-20 09:06:09] <web> {} [info] http started on port 8080

If you do not see the \"http started on port XX\" message then you

probably have a port conflict. Try changing to a different port using

the setup program.

If you are running on Windows and see security exceptions with a message

such as \"system cannot write files\", then you might have UAC issues.

If you right click \"skyspark.bat\" and try \"Run as administrator\". If

you are trying to run from an existing \"cmd.exe\" terminal, then make

sure you started the terminal as administrator.

The skyspark server is just a daemon process. Once it is running

successfully you will need to

login with

your browser.

Running as Windows Service {#runWinService}

On Windows, you can use the \"fansc.exe\" program to install SkySpark as

a windows service. For example, to install SkySpark as a service and run

it on port 8080:

C:\skyspark-3.0.4\bin\> fansc.exe install SkySpark-3.0.4 C:\skyspark-3.0.4\bin\skyspark.bat

See the

fansc

documentation for general information about the tool. After you have

installed the service, you should manage it with the standard windows

tools. As a convenience, \"fansc\" can also be used to uninstall a

stopped service:

C:\skyspark-3.0.4\bin\> fansc.exe uninstall SkySpark-3.0.4

Java Home {#javaHome}

On Windows and Unix, the \"fanlaunch\" script will to choose the version

of Java to use via the following rules from highest priority to lowest:

FAN_JAVA environment variable
JAVA_HOME environment variable
whatever Java is in your default path

On Windows it is typical to have both a 32-bit and 64-bit JVM, but

larger systems will require that you explicitly run with a 64-bit JVM to

access a bigger heap.

Run skyspark -version to check which version of Java you are running

with.

To learn more about choosing between 32-bit versus 64-bit, see

Deployment

and Tuning.

Logging In {#logginIn}

Once the software is running you can hit it with your browser using

http://localhost:8080/ (or whatever port you are using).

When you first install the software the only user account available is

the superuser account which has a username of \"su\" and the password

configured by

setup program.

DemoGen

When you first install SkySpark it contains no project databases. To get

started we recommend you generate the standard demo database:

Log in as su
Go to the Project Manager
Run the demogen command
You will now have a project named demo

Once demogen runs, the following user accounts are also created:

- username \"demoben\", password \"pass\", admin account
- username \"demojack\", password \"pass\", operator account

Upgrades

New builds are posted on the

Downloads tab of skyfoundry.com. A

skyfoundry.com account with appropriate permissions is required to

download new builds. You will need to manually download the skyspark zip

file and perform a new install for each build.

By convention you should install each skyspark build into the same

parent directory. For example:

opt/
skyspark-3.0.4/
skyspark-3.0.5/

All your variable files are stored in a directory named \"var/\" which

defaults to under the install directory. The safest way to perform an

upgrade is to copy your var directory from the old version to the new

version. Make sure neither the old nor new versions are running while

you make this copy. A fresh complete copy provides the opportunity to

fallback to an older version. Or for very large systems you might choose

to just have a single \"var/\" directory shared by all versions using

the -var command line flag.

Patches {#patching}

Patches are posted on the Downloads

tab of skyfoundry.com. Patches may be manually installed as follows:

Shutdown skyspark
Copy patch to lib/fan
Restart skyspark

Licensing

In order to run a copy of SkySpark, a valid license file is required to

be installed to the \"var/lic/\" directory. See

Licensing for

further details.

Documentation {#docs}

Documentation is available online at http://skyfoundry.com/doc/ with a

community user account. The documentation may also be accessed from a

local SkySpark installation using the HelpApp from within a project. The

first access will generate the documentation to the \"{home}/doc\"

directory. You can also manually generate documentation for a SkySpark

installation using the command:

fan docgen

Conversion to Metric {#convertToMetric}

The demo database which ships with SkySpark contains a set of fictional

sites in the United States using the imperial unit system. An Axon

function named convertToMetric can be used to rewrite the demo data to

alternate cities, timezones, and the metric system.

This script should to spawned as a background job as follows:

jobRun( convertToMetric() )

This script applies a number of changes to the database:

Rewrites tags on your regions, sites, and weather recs (default is
London/Manchester)
Converts units from imperial to metric (°F -> °C, inH₂O -> kPa,
gal -> m³)
Converts all history data to alternate timezones (default is London)
Converts cost unit from $ (default is £)

The top of the script contains a set of constants and mapping tables

which may be customized for the cities and countries of your choice. If

you wish to switch back and forth between US and metric, then make a

copy of the demo database before running the conversion program.

NOTE: restart is required to refresh the weather forecast data.

- 2. Deployment
:::
:::

::: {.footer}

SkySpark∙Build 3.0.18∙28-Dec-2018 Fri 1:13:00PM CST

:::

[]{#buffer-extension-hover-button

style="display: none; position: absolute; z-index: 8675309; width: 100px; height: 25px; background-image: url("chrome-extension://noojglkidnpfjbincgijbaiedldjfbhh/data/shared/img/buffer-hover-icon@2x.png"); background-size: 100px 25px; opacity: 0.9; cursor: pointer;"}
Was this article helpful?
Cancel
Thank you!