|
219 | 219 | * dualStorage |
220 | 220 | * an adapter for Backbone's Backbone.Sync() method to handle saving to a localStorage database as a cache for the remote models. This allows us to provide offline capabilities so users can continue to work while disconnected from the internet and then when reconnected, the model changes will be synchronized with the server. |
221 | 221 |
|
222 | | -### Download |
| 222 | +### Installing |
| 223 | +DataWolf can be deployed in two different ways. Users can either use [Docker](https://www.docker.com/) or manually installed using the provided zip file. Using Docker is the quickest way to run DataWolf and can be used |
| 224 | +for testing features and development. It can be used in production, but it will likely require using a custom build to include dependencies for workflow tools. |
| 225 | + |
| 226 | +### Docker |
| 227 | + |
| 228 | +To start using DataWolf using Docker, you can use the provided [docker compose file](https://opensource.ncsa.illinois.edu/bitbucket/projects/WOLF/repos/datawolf/browse/docker-compose.yml). Environment settings |
| 229 | +can be found in [env.example](https://opensource.ncsa.illinois.edu/bitbucket/projects/WOLF/repos/datawolf/browse/env.example). To get started, do the following: |
| 230 | + |
| 231 | +* Install [Docker](https://www.docker.com/) |
| 232 | +* Start up all required services with ```docker-compose up -d``` (detached mode) |
| 233 | +* To see the logs, run ```docker-compose log -f``` |
| 234 | +* To stop the containers, execute ```docker-compose down``` in the same directory |
| 235 | + |
| 236 | +All commands need to be executed in the same directory at the DataWolf docker compose file. When running the first, you may get an error connecting to the database if DataWolf starts before the |
| 237 | +PostgreSQL database. Stopping and starting the container again will fix this. |
| 238 | + |
| 239 | +### Manual Installation |
223 | 240 |
|
224 | 241 | The latest version of Data Wolf can be downloaded from: |
225 | 242 |
|
226 | 243 | https://opensource.ncsa.illinois.edu/projects/artifacts.php?key=WOLF |
227 | 244 |
|
228 | | -By default, the latest release is selected in the page (currently 4.4.0). To get early access to development releases, check the box **Show also prereleases.** |
| 245 | +By default, the latest release is selected in the page (currently 4.5.0). To get early access to development releases, check the box **Show also prereleases.** |
229 | 246 |
|
230 | 247 | * Click on **Version** |
231 | | - * Select **4.4.0** |
232 | | - * Under **Files** select **datawolf-webapp-all-4.4.0-bin.zip** |
| 248 | + * Select **4.5.0** |
| 249 | + * Under **Files** select **datawolf-webapp-all-4.5.0-bin.zip** |
233 | 250 | * Click **I Accept** to accept the License. |
234 | 251 |
|
235 | 252 | This will give you the latest stable build that includes both the Data Wolf Server and the Web Editor. You can also find links to the javacode there as well as the manual. The link to the source code can be found at the end of this document. |
236 | 253 |
|
237 | 254 | ### Installation and Setup |
238 | 255 |
|
239 | | -To install the files necessary for the Server and Editor, find where you downloaded Data Wolf and unzip it somewhere. This will create a folder called **datawolf-webapp-all-4.4.0**. In the next few sections, we'll discuss some of the important files that come with the installation you just unzipped so you can tailor your setup to meet your needs. If you wish to skip this, you can go directly to the section **Running Data Wolf Server and Editor**. |
| 256 | +To install the files necessary for the Server and Editor, find where you downloaded Data Wolf and unzip it somewhere. This will create a folder called **datawolf-webapp-all-4.5.0**. In the next few sections, we'll discuss some of the important files that come with the installation you just unzipped so you can tailor your setup to meet your needs. If you wish to skip this, you can go directly to the section **Running Data Wolf Server and Editor**. |
240 | 257 |
|
241 | 258 | #### Data Wolf properties |
242 | 259 |
|
|
402 | 419 |
|
403 | 420 | #### Launch Scripts |
404 | 421 |
|
405 | | -If you go back to the folder **Data Wolf-webapp-all-4.4.0** you will see a sub-folder called **bin**, open this. Inside you will find two scripts, **datawolf-service** and **datawolf-service.bat**. The latter is intended for running Data Wolf on a Windows machine and the former is for running on Mac & Linux. As with the previous section, knowledge of this file is not required unless you are interested in configuring the Data Wolf Server and Editor beyond the default settings. We will show snippets of the file **datawolf-service** and discuss what each section is configuring. |
| 422 | +If you go back to the folder **Data Wolf-webapp-all-4.5.0** you will see a sub-folder called **bin**, open this. Inside you will find two scripts, **datawolf-service** and **datawolf-service.bat**. The latter is intended for running Data Wolf on a Windows machine and the former is for running on Mac & Linux. As with the previous section, knowledge of this file is not required unless you are interested in configuring the Data Wolf Server and Editor beyond the default settings. We will show snippets of the file **datawolf-service** and discuss what each section is configuring. |
406 | 423 |
|
407 | 424 | ``` |
408 | 425 | # port for the jetty server |
|
0 commit comments