Commit b916d6f0 authored by Sam McCollum's avatar Sam McCollum

Merge branch 'add_ci_badge' into 'master'

Add ci badge, update README

See merge request !37
parents ae50aab3 d2458961
Pipeline #539 passed with stages
in 2 minutes and 10 seconds
[![pipeline status](http://gitlab.mccollum.enterprises/icing/media/badges/master/pipeline.svg)](http://gitlab.mccollum.enterprises/icing/media/pipelines)
# Icing Node
## Install
### Prerequisites
#### Raspberry Pi
- Java JDK 1.8 or higher
- Maven 3.3+ (recommend latest)
- Git (binary packages coming soon
//Install CentOS using the instructions found [here](https://wiki.centos.org/SpecialInterestGroup/AltArch/Arm32/RaspberryPi3)
#### Raspberry Pi
Install Fedora using the instructions found [here](https://fedoraproject.org/wiki/Architectures/ARM/Raspberry_Pi)
......@@ -14,19 +18,37 @@ Follow the regular instructions for Fedora
#### Mac OS X
`//TODO: do we care?`
Assuming Java JDK 1.8 has already been installed, enter the following commands into a window of the `Terminal` application:
```bash
$ xcode-select --install
$ brew install maven
```
#### Fedora
1. `$ sudo dnf install java-1.8.0-openjdk-devel maven git`
```bash
$ sudo dnf install -y java-1.8.0-openjdk-devel maven git
```
#### CentOS
1. `$ sudo yum install java-1.8.0-openjdk-devel maven git`
```bash
$ sudo yum install -y java-1.8.0-openjdk-devel maven git
```
#### Debian
1. `$ sudo apt-get install ???? git`
```bash
$ sudo apt-get -y install openjdk-8-jdk maven git
```
#### Windows
Using the package manager [chocolatey](https://chocolatey.org/):
1. Run PowerShell or Command Prompt as an administrator
1. Run: `choco install maven git`
### Installation
......@@ -47,7 +69,14 @@ Change to the directory (`$ cd ~/git/media`)
Run with:
`$ ./icing.sh`
(this will create database files named `icing-database.h2.db` and `icing-database.trace` to store your data)
(this will create database files named `icing-database.h2.db` and `icing-database.trace.db` to store your data)
#### Windows
1. Open the command prompt
1. Use the `cd` command to change to the directory where icing was downloaded
1. Run with: `mvn wildfly-swarm:run`
1. For convenience, you could put this command into a `*.bat` file in that directory
### On App Server (like Wildfly)
......@@ -62,7 +91,7 @@ Using the instructions for your app server (we are using Wildfly 10+ for develop
1. Create a JPA data source with the JNDI name `java:/icing-media`
1. If using MySQL or MariaDB, perform the following database setup in the MySQL/MariaDB console (assuming your db is named `icing`):
1. If using MySQL or MariaDB, perform the following database setup in the MySQL/MariaDB console (replace `icing` with the name of your database):
1. `ALTER DATABASE icing DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;`
1. Deploy the `icing.war` file to your app server using the instructions on its website (different for Wildfly/JBoss, Glassfish/Payara, etc.)
......
@echo off
ECHO "Starting Icing..."
mvn -DskipTests clean wildfly-swarm:run
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment