# README - Quick Start Guide

2025-NOV-8

#### www.dataspeeder.com

## 1 - System Requirements

DataSpeeder requires Java to be installed on the computer to run (Windows, Linux, or Mac).

To confirm that you have Java installed, do the following ...

1. Open a command prompt, and enter the command: java -version
   If Java is installed, you will see the version number indicated like this.

Supported versions of Java:

- Java 1.8 LTS (aka Java 8 LTS)
- Java 11 LTS
- Java 17 LTS
- Java 21 LTS

## 2 - How to run DataSpeeder

Do the following ...

1. Extract the DataSpeeder ZIP file to a convenient location.
   Example: C:\dataspeeder-2.0
2. Open a command prompt and change to that directory.
   Example: cd C:\dataspeeder-2.0
3. On Windows, launch DataSpeeder using the command:
   startup.bat
   On Linux or Mac, make the startup script executable:
   chmod +x ./startup.sh
   Launch DataSpeeder using the command:
   ./startup.sh
   NOTE: The default DataSpeeder port is 8080 (ex. http://localhost:8080).
   To run with a different port, use the command line parameter --server.port=<port-number>
   Example: startup.bat --server.port=8081
4. You will see DataSpeeder start up like so ...
5. When you see "DATASPEEDER IS READY TO USE ON PORT", the application server is running on the port specified ...
6. Open a web browser to http://localhost:8080 (8080 or the specified port) and you will see the DataSpeeder home page.

## 3 - Next Steps

### 3.1 - Use the Demo app

Click on the "Demo Movie Application" to use the demo application.

Trying viewing, searching, and navigating the data.

### 3.2 - Sign in as "admin" to edit data and configure apps

To sign in, use the default account "admin" (default password is "password").

After signing in, you can edit data and visit the "Admin Page" to configure database connections and applications.

### 3.3 - SECURITY NOTE: Changing the default 'admin' password

To change the default "admin" password, sign in as "admin", then click "Admin Page" > "Users". Click the username "admin", then "Edit", change the password and click "Save".

### 3.4 - SECURITY NOTE: HTTP and HTTPS Security

- Web app runs on HTTP only (`http://localhost:8080`)
- Do not expose to the internet: Passwords and DB credentials are sent from browser to app server unencrypted
- For production: Use a reverse proxy (NGINX, Apache, Caddy) with HTTPS

## 4 - "How To" videos and Docs

For "How To" videos and documentation, please visit the DataSpeeder Support web page.

## 5 - Evalution License

DataSpeeder comes with a 30 days evaluation license, additional licenses are available by request.

To view current license details (including expiry date), click "Sign In" to sign in as user "admin" (default password is "password"). Then click "Admin Page" > "License".

## 6 - Contact

We want DataSpeeder to be useful.

If you have any questions or feedback or something is preventing you from having a positive experience, please let us know so we can improve it for you!

Thanks,

-- DataSpeeder Support, DataSpeeder Support