Skip to content

Commit

Permalink
some 0.4.2 changes, more needed
Browse files Browse the repository at this point in the history
  • Loading branch information
osullivj committed Feb 7, 2017
1 parent 3ab0ee4 commit d40e057
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 19 deletions.
18 changes: 7 additions & 11 deletions guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ SpreadServe User Guide
Once you've installed SpreadServe, you can start and stop it's server processes using a couple of scripts in the sh subdirectory.
Here's how you would start SpreadServe::

cd c:\SpreadServe\ss0.2.0\sh
cd c:\SpreadServe\ss0.4.2\sh
launch SIT baseweb

And here's how you can halt SpreadServe::

cd c:\SpreadServe\ss0.2.0\sh
cd c:\SpreadServe\ss0.4.2\sh
halt SIT
The launch script takes two parameters: environment name (SIT), and profile (baseweb). SpreadServe processes use the environment
Expand All @@ -22,16 +22,12 @@ JSON format, and specify which processes SpreadServe should start when launched;

**Logging in to the web user interface**

When SpreadServe is running, you can point your browser at the SpreadServe RealTimeWebServer and login.
When SpreadServe is running, you can point your browser at the SpreadServe RealTimeWebServer and login by clicking the login button at top
right.

Note the port number in the URL: 8090. So if SpreadServe is running on a Windows Server with the hostname sshost,
the URL you should enter in your browser will be http://sshost:8090 To login you should use your Google or Github identities.

.. image:: img/ss_login.jpg
:alt: Logging in to SpreadServe

Note the port number in the URL: 8888. So if SpreadServe is running on a Windows Server with the hostname sshost,
the URL you should enter in your browser will be http://sshost:8888 To login you should enter your Windows credentials.
So in a corporate environment the username will be the same one you use to login to your Windows PC. Outside a corporate
environment, if you're running SpreadServe on a personal laptop, you'd use the same username and password as you do when
starting Windows itself.

**User Interface: dashboard**

Expand Down
15 changes: 7 additions & 8 deletions install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ repackaging simple and modular, and to minimise system wide host impact.
**Installing SpreadServe for the first time**

* Download the installer from our download page to your target Windows host.
* Launch the ss_install_0.3.1.exe installer by double clicking, or running it at the command line.
* Launch the ss_install_0.4.2a.exe installer by double clicking, or running it at the command line.
* Check the license terms and click "I Agree".
* Choose your install options

Expand All @@ -24,26 +24,25 @@ repackaging simple and modular, and to minimise system wide host impact.
perhaps as user variables rather than system wide.

* Click Close when the Installer finishes.
* Open a new command shell, cd to ``c:\SpreadServe\ss0.3.1\sh``
* Open a new command shell, cd to ``c:\SpreadServe\ss0.4.2\sh``
* ``launch SIT baseweb``
* Point your browser at http://localhost:8888 to see the web UI home page.
You may need to enter your Windows user ID and password if you're not authenticated.
* Point your browser at http://localhost:8090 to see the web UI home page.

**Uninstalling SpreadServe**

* Delete the ``c:\SpreadServe\ss0.3.1`` directory tree
* Delete the ``c:\SpreadServe\ss0.4.2`` directory tree
* Go to Control Panel/System/Advanced System Settings/Environment Variables and delete the SSROOT and SSROOTX variables from System variables.
* That's it! SpreadServe does not touch the Windows Registry.

**Directories and environment variables**

By default SpreadServe installs in ``c:\SpreadServe\ss0.3.1``. You can change this in the install process, but below we assume you've taken the default.
By default SpreadServe installs in ``c:\SpreadServe\ss0.4.2``. You can change this in the install process, but below we assume you've taken the default.
Where relative directories are mentioned, without the full path name, they are relative to the ``SSROOT`` environment variable which SpreadServe requires
to be set to the root of it's install. If you selected the 'Env vars' option in the install you won't need to set the environment variables yourself.
If not, you can set them in a command shell like so::

set SSROOT=c:\SpreadServe\ss0.3.1
set SSROOTX=c:/SpreadServe/ss0.3.1
set SSROOT=c:\SpreadServe\ss0.4.2
set SSROOTX=c:/SpreadServe/ss0.4.2
``SSROOTX`` is the same as ``SSROOT``, but with backslashes translated to forward slashes, and any spaces rendered as %20.

Expand Down

0 comments on commit d40e057

Please sign in to comment.