Weave Server Assistant

The Weave Server Assistant will guide you through the process of downloading, installing, and configuring Weave on your system. It is designed to work with new or existing Weave installs on Windows, Mac OS X, and Linux.

To get started, please make sure you have the software requirements detailed below for your system.
You may then download the Weave Server Assistant by clicking on the link in the Download section below.

Software Requirements

  • Ubuntu Users can run:
    1. sudo add-apt-repository ppa:webupd8team/java
    2. sudo apt-get update
    3. sudo apt-get install oracle-java7-installer
    4. sudo update-alternatives --config java

Download

Install

There are four major steps that need to be taken in order to successfully install Weave on your system. Here we describe each step so you may have a better understanding of the process.

Select Application Server

The first step after starting up the Weave Server Assistant is to select an application server. This server will act as an environment for Weave to run in and supply an interface for Weave services to communicate between the database and the webpage.

There are currently two choices to choose from:

  • Jetty is the first and default choice for new users. It provides a simple self-controlled server environment that runs with the Weave Server Assistant. This means that if Jetty is selected, when the Server Assistant is started, Jetty is also started. Similarly, when the Server Assistant is closed, Jetty is also closed.
  • Tomcat is the second option to choose (as seen below). Apache Tomcat is provided by the Apache Software Foundation and is designed to run on your system as a system service. Using Tomcat requires that you supply the Weave Server Assistant the path to the webapps folder of your Tomcat installation. This is important so that the Weave Server Assistant knows where to put the downloaded Weave files.
    The typical Tomcat install path on a Windows system is C:/Program Files/Apache Software Foundation/Tomcat X.0/.

All of these options require that you specify a port number that matches the port the service is running on. You may need to change this if your ports are not default.

Select Database Application

The next step is to select a database server to store Weave configurations and your personal uploaded data.

There are several choices to choose from:

  • SQLite is the first and default choice for new users. It provides a self-contained, serverless, zero-configuration, transactional SQL database engine. Due to the fact that this choice is serverless, it does not need a host and port number.
  • MySQL, PostgreSQL, and Oracle Database are the other choices that incorporate a server environment. Each of these will need a hostname/IP and a corresponding port number.
    Localhost is the default destination for your own system, but if you choose to use an alternate database server you may choose to do so here.

Install Weave

Now that we have selected our server and database, we are ready to install the Weave package. As shown below, we can quickly and easily check to see if there is a newer version of Weave available by clicking on the Refresh button. This will automatically fetch the latest version from our GitHub repository and compare it to your local revision repository to see if there is a match.

If there is a match, then you will see a status message stating that your install is Up to Date.
If no match is found, then you will see a status message stating Update Available and you may proceed with the install.

By clicking on the Install button, the Server Assistant will automatically download the correct zip file and move it to your server's webapps folder that you previously specified.

Configure Admin Console

Finally, Weave has been downloaded and installed. We can now configure the Admin Console with a username and password as well as a connection to the database we set up in a previous step.

  • Select the Sessions tab
  • Click on the Open Admin Console button

Below, is the first screen that will pop up when opening the Admin Console.

  • Enter username and password credentials for subsequent logins.
    • As an example, weave/12345 has been used for the username and password respectively.
  • Specify the connection to the database with the IP/port and username/password if required.
    • As an example, root/password has been used for the username and password respectively for MySQL on localhost.

Tips and Tricks

Switching between Milestone and Nightly build downloads

Weave milestones provide a stable environment in which common issues and bugs have been resolved. Weave nightly builds contain more features than Weave milestones but may not be as stable. By default, Weave milestones are the default download. You may switch downloads by

  • Select the Weave tab
  • Hold down the Refresh button for half a second
  • Select one of the options in the drop down box

Installing Weave in offline mode

In circumstances when an internet connection is not available or not desired, the Weave Server Assistant can operate in offline mode.

To install a new version of Weave in offline mode:

  • Download either the milestone or nightly build found under Weave Binary Archives
  • Save the zip to your desktop or download folder
  • Drag and drop the zip file into the Revision table on the Weave tab
  • Click on the revision in the box and click on the Deploy button to install

Troubleshooting

How do I find my Weave Server Assistant folder?

  • Windows
    • Open a run prompt by holding down the Windows Key + R
    • Type in the text prompt: %APPDATA%
    • Hit Enter
    • Find the folder named .weave
  • Mac OS X
    • Open a terminal window and input the following:
    • cd ~/Library/Application\ Support/.weave/
  • Linux
    • Open a terminal window and input the following:
    • cd ~/.weave/

Weave Server Assistant won't open after updating

  • Check to make sure you have installed all system requirements
  • Run the Weave Server Assistant under an account with Administrative privileges
  • Check the log files for startup errors found in /.weave/logs/ (instructions above)

I cannot select the webapps folder for my Tomcat installation

  • Make sure there is a ROOT folder inside of the webapps folder to store all Weave files

I receive a Server Not Found error when opening the AdminConsole / session state

This is caused by a communication issue between the client and server.

  • If you are using Tomcat:
    • Make sure your Tomcat installation is running
    • Restart the Tomcat service to see if the problem persists
    • Make sure that the port defined in the Weave Server Assistant matches the port the Tomcat service is running on
  • If you are using Jetty:
    • Restart the Weave Server Assistant
    • If the problem still persists, open the .weave folder (instructions above)
    • Navigate to /plugins/Jetty/logs/
    • Find the most recently modified stdout and stderr files.
    • Include these in a bug report describing the issue.

I receive a 404 Not Found error when opening the AdminConsole / session state

This is caused by the client requesting content the server does not have.
If you are receiving this error after downloading and installing Weave, you may not have write permissions to the directory.
Please make sure you are running on a system account with administrator privileges.

  • If you are using Tomcat:
    • Make sure you have selected the correct webapps folder in the Weave Server Assistant for your Tomcat installation
    • Navigate to your Tomcat's webapps folder using your system's file browser
    • Check to see if these files exist
      • WeaveServices.war
      • /ROOT/AdminConsole.html
      • /ROOT/weave.html
    • Redeploy the Weave install files by using the Weave Server Assistant
    • If the problem persists, check the most recent log files under .weave/logs/
  • If you are using Jetty:
    • Navigate to Jetty's webapps folder found in .weave/plugins/Jetty/webapps/
    • Check to see if these files exist
      • WeaveServices.war
      • /ROOT/AdminConsole.html
      • /ROOT/weave.html
    • Redeploy the Weave install files by using the Weave Server Assistant
    • If the problem persists, check the most recent log files under .weave/logs/

wsa2.png (26.8 KB) Pat Stickney, 05/27/2015 06:42 PM

wsa3.png (20.5 KB) Pat Stickney, 05/27/2015 06:42 PM

wsa4.png (16.8 KB) Pat Stickney, 05/27/2015 07:17 PM

wsa5.png (15.6 KB) Pat Stickney, 05/28/2015 04:50 PM

wsa_refresh.png (19.8 KB) Pat Stickney, 06/01/2015 02:26 PM

wsa_install_offline.png (34.7 KB) Pat Stickney, 06/01/2015 02:26 PM

wsa6.png (18.7 KB) Pat Stickney, 06/09/2015 02:03 PM